이 프로젝트를 찾았습니다. https://github.com/OAI/OpenAPI-Specification 나는 이해 했으므로 .json/.yml 개의 파일로 문서를 작성할 수 있습니다. 내가 할 수있는 한 http://editor.swagger.io/은 쉽게 .html 파일로 렌더링 될 수 있습니다.스프링 부트 프로젝트에 Swagger OpenAPI 사양을 추가하십시오.
내 질문 - 어떻게 그 파일에서 정적 .html 페이지를 생성 할 수 있습니까? 스프링 부트 응용 프로그램에 대한 자습서가 있습니까? 어떻게 든 .json/.yml 파일을 문서를 준비하고 .html 파일을 준비하려면 흔들리는 구성에 제공해야합니까?
.yml 또는 .json 개의 파일에서 HTML, 자바 스크립트 및 CSS 애셋 모음을 생성 할 필요가 없습니다. Swagger UI을 실행하는 서버에 YAML/JSON 파일을 전달하면 Swagger UI가 Swagger 호환 API에서 아름다운 문서를 동적으로 생성합니다. petstore 예제를 통해 아이디어를 얻을 수 있습니다.
Jenkins와 같은 빌드 엔진 (CI/CD 서버 또는 기타)을 사용하여 문서 게시 프로세스를 자동화 할 수 있습니다. 예를 들어, 각 REST API 저장소는 .yml 또는 .json 개의 파일 중 하나 이상을 제공해야합니다 (Swagger Editor에서 생성 됨). 그런 다음 해당 저장소로 이동 한 후 Jenkins는 .yml 또는 .json 개의 파일을 가져 와서 Swagger UI가 실행중인 문서 서버에 업로드합니다.
REST API 개발자는 클라이언트 개발자와 API 설명서 링크를 공유 할 수 있으며 .yml 또는 .json 파일의 각 변경 사항이 문서에 반영 될 것으로 확신 할 수 있습니다. 변경 사항을 적용하면됩니다. Swagger 호환 API를 유지해야하기 때문에 더 읽기 쉽기 때문에 개인적으로 .yml 파일을 사용하는 것이 좋습니다.
swagger-ui가 json을 같은 디렉토리에서 렌더링 할 수 있습니까? 예를 들어, 내/정적 컨텐츠 폴더에 swagger-ui가 있으며 swagger.json 파일도 있습니다. –
@Orest 가능해야합니다. 당신은 swagger UI에'yml' 파일 링크를 전달합니다. –