GitHubPages에서 Swagger 호스팅

Swagger 정보

THE WORLD'S MOST POPULAR API TOOLING
세계에서 가장 인기 있는 API 도구
Swagger is the world’s largest framework of API developer tools for the OpenAPI Specification(OAS), enabling development across the entire API lifecycle, from design and documentation, to test and deployment.
Swagger는 OpenAPI 사양(OAS)을 위한 API 개발 도구의 세계 최대 프레임워크로, API 수명 주기 전반에 걸쳐 설계부터 문서화, 테스트 및 배포까지 가능합니다.
htps : // 슈게 r. 이오

특징

YAML/JSON에서 API 사양 작성

AWS ApiGateway 등에서 지원되며 가져오기/내보내기 가능

다양한 도구가 제공됩니다.

Swagger Editor : API 사양 편집 및 유효성 검사

Swagger Codegen : API 사양을 기반으로 코드 생성

Swagger UI : API 사양을 기반으로 시각화

Swagger Inspector : 테스트 도구

GitHub Pages

새 서버를 준비 할 필요가 없습니다

버전 관리하면서 최신 API 사양을 볼 수 있습니다

절차

Swagger UI 저장소 htps : // 기주 b. 코 m / 슈게 r- 아피 / 슈 게 r- 우이에 포함 /dist 디렉토리 복사

dist/index.html 내의 swagger 정의의 참조처를 변경한다
htps : // 기주 b. 코 m / 슈게 r- 아피 / 슈 게 r - 우 / b ぉ b / 뭐 r / st / 어서 x. HTML#L77

파일 세트를 GitHub로 푸시

GitHub > Settings > GitHub Pages 에서 GitHub Pages 사용

Check https://{user_name}.github.io/{repository_name}/

참고

공식 절차 htps : // 슈게 r. 이오 / 드 cs / 슈게 r와 ls > Swagger UI Documentation > Usage

구현 예 htps : // 기주 b. 코 m / 쟈모토 / 슈 게 r 퍼게 s mp ぇ

npm 모듈도 제공됩니다 htps //w w. 음 pmjs. 코 m / Pac 카게 / 슈 게 r- 우이 ぢ st

SwaggerUI 테마가 있습니다 htp // 메오 st 란 r. 코 m / 슈게 r- 우이 ぇ 메 s