오프라인 Swagger API 문서를 생성하는 방법은 무엇입니까?
저는 봄부트 MVC 자바 웹 앱을 가지고 있습니다.API 문서화를 위해 Springfox를 통합할 수 있었습니다.나는 서버가 가동되고 있을 때 모든 API를 시각적으로 볼 수 있습니다.
오프라인 스웨거 API 문서를 생성하려면 어떻게 해야 합니까?참고: 저는 sciidoc 또는 markdown 문서를 사용하고 싶지 않지만 html 파일에서 동일한 swagger API 사용자 인터페이스를 원합니다.링크가 로컬 호스트 서버 링크가 아닌 로컬 디렉터리에 상대적으로 연결되도록 하고 싶습니다.감사해요.
Swagger에는 오프라인 문서를 생성하는 도구가 있습니다.
도구는 @ Github에 위치한 "Swagger2 Markup"입니다.
"스웨거2 마크업"의 출력은 스웨거-의 대안으로 사용될 수 있으며 정적 콘텐츠로 제공될 수 있습니다.
행운을 빌어요! :)
Springfox를 사용하면 Spring 주석을 기반으로 Swagger 테스터/API 문서를 쉽게 만들 수 있습니다.
Swagger 자체에는 오프라인/정적 문서를 생성할 수 있는 몇 가지 도구가 있습니다.
- Swagger Editor에는 클라이언트 생성 메뉴에 나열된 문서를 생성하는 여러 가지 방법이 있습니다.
- Swagger Codegen 모듈을 사용하여 정적 및 동적 HTML 문서를 생성할 수 있습니다.
둘 다 Swagger YAML 또는 JSON 파일이 필요합니다.스프링폭스를 사용하고 있어서 YAML/JSON에 Swagger 정의가 없는 경우 Swagger UI에 사용되는 생성된 파일을 사용할 수 있습니다./v2/api-docs?group=<group name>).
https://editor.swagger.io 의 "Generate Client" 메뉴에서 "HTML" 또는 "Dynamic HTML"을 사용할 수 있습니다.정적 문서에 대한 문제/피드백은 스웨거 코드젠 깃허브 보고서에 보고하십시오.
editor.swagger.io 은 https://generator.swagger.io 을 활용하여 코드를 생성하며, generator.swagger.io (스웨거 제너레이터)는 Swagger Codegen 프로젝트의 일부입니다.
라이브 스웨거 HTML을 엽니다. 모든 작업을 확장하려면 클릭하십시오.그런 다음 HTML을 PDF로 저장합니다.
이렇게 하면 모든 세부 정보가 포함된 PDF API 문서를 얻을 수 있습니다.
Pretty-swag는 정적 HTML 및 다른 형식을 생성할 수 있는 Swagger 사양 V2용 UI입니다.Swagger Editor에서 영감을 받았습니다.
체크아웃 https://github.com/twskj/pretty-swag
당신은 https://www.DynamicApis.com 을 볼 수도 있습니다.당신은 API 포털을 만들고 당신의 스웨거 JSON 문서를 업로드할 수 있습니다.이 사이트는 Swagger 문서를 사용하여 API를 위한 훨씬 더 멋진 사용자 인터페이스와 몇 가지 멋진 도구를 생성합니다.
다음은 API 중 하나에 설명서가 있는 포털 API의 예입니다.
이 작업을 수행하는 두 가지 방법이 있습니다.
- Swagger 자체에는 오프라인/정적 문서를 생성할 수 있는 몇 가지 도구가 있습니다.
GitHub의 swagger-api/swagger-codegen 프로젝트, README 프로젝트는 정적 HTML을 생성하는 방법을 보여줍니다.정적 html api 문서 생성을 참조하십시오.
- 오프라인 Swagger API 문서를 생성하고 사용자 친화적인 인터페이스와 공유하는 또 다른 번거롭지 않은 방법이 있습니다.
Syncloop을 사용하여 Swagger API 사양 파일(일반적으로 JSON 또는 YAML 형식)을 업로드하고 시각적으로 매력적인 API 문서를 생성할 수 있습니다.API 문서의 스타일과 설정을 사용자 지정할 수 있습니다.만족하면 생성된 HTML 파일을 다운로드할 수 있습니다.
언급URL : https://stackoverflow.com/questions/34984820/how-to-generate-offline-swagger-api-docs
'programing' 카테고리의 다른 글
| Oracle SQL 개발자의 DB2 데이터베이스 (0) | 2023.06.23 |
|---|---|
| Oracle과 같이 mysql의 날짜 필드 잘라내기 (0) | 2023.06.23 |
| Elmah가 asp.net 사이트에서 작동하지 않습니다. (0) | 2023.06.23 |
| Kotlin @ConfigurationProperties 클래스에 대한 IntelliJ Idea에서 spring-configuration-metadata.json 파일이 생성되지 않습니다. (0) | 2023.06.23 |
| 도커 컨테이너에서 mongoimport를 실행합니다. (0) | 2023.06.23 |