SwagDoc

Swagdoc

Swagdoc은 Swagger Spec 버전 2.0 용 Swagger.json 파일을 생성하는 델파이 라이브러리입니다. 델파이 언어 용 Swagger 2.0을 사용하여 공개 문서 REST API를 만듭니다. Swagdoc의 유일한 책임은 Swagger.json 파일을 생성하는 것입니다. Swagger.json 파일은 REST API에 대한 모든 문서를 포함해야합니다. 이 파일은 Swagger UI (사용자 인터페이스) 파일에 첨부되어야합니다.

Swagger (Open API) - 버전 2.0

SWAGDOC는 시장에서 더 인기가 있고 가장 긴 버전으로 간주되기 때문에 Specification 2.0을 따릅니다. SWAGDOC는 아직 Swagger 3.0 버전을 지원하지는 않지만 프로젝트에 대한 수요와 기여에 따라 Spec 3.0을 지원하기 위해 진화 할 수 있습니다.

SWAGDOC 작업을위한 주요 전제 조건은 아래 링크에서 볼 수있는 Swagger 2.0 사양을 아는 것입니다.

https://github.com/oai/openapi-scification/blob/master/versions/2.0.md

https://swagger.io/docs/specification/2-0/basic-structure/

REST API에 대한 Swagger 문서를 만들 때 다음 예제와 같은 페이지를 생성 할 수 있습니다.

https://app.waggerhub.com/apis-docs/wagdoc/sample-api/v1

JSON 스키마

https://github.com/oai/openapi-scification/blob/master/versions/2.0.md#schemaobject

http://json-schema.org

Swagdoc 연설

https://www.youtube.com/watch?v=9U3HP3B5UT0 (PT-BR)

https://www.youtube.com/watch?v=PHGMQAD8O6C (PT-BR)

Swagger 참조 및 튜토리얼

https://swagger.io/swagger/media/blog/wp-content/uploads/2017/02/documenting-an- encisting-pi-with-swagger-2.pdf

https://idratherbewriting.com/learnapidoc/pubapis_wagger_intro.html

스와그 도구

• Swagger : https://swagger.io

• Swagger 편집기 : https://editor.wagger.io

• Swagger Hub : https://swagger.io/tools/swaggerhub

• 클래식 스웨거 샘플 : http://petstore.wagger.io

• 도구 및 통합 : https://swagger.io/tools/open-source/open-source-integrations

Swagger UI 배포 파일

Swagger 문서가 포함 된 페이지를 작성하려면 Swagger UI 배포 파일이 필요합니다.

이 파일은 Github Swagger-API / Swagger-UI 저장소에서 찾을 수 있습니다.

https://github.com/swagger-api/swagger-ui/tree/master/dist

먼저 Swagger 사용자 인터페이스 파일을 다운로드하고 swagger.json 파일을 생성해야합니다. 그런 다음 swagger.json 파일이 Swagger 사용자 인터페이스 파일을 호스팅하는 웹 서버에있는 위치의 상대 경로를 표시하려면 Index.html 파일을 변경해야합니다.

아래 예를 참조하십시오.