swagger에 대해 알아보자

swagger

: Rest API에 대한 문서화 및 관리, 테스트를 지원하는 오픈 소스 프레임워크 (Open Api Specification, OAS)

: 코드 몇 줄만으로 API 문서를 쉽게 만들 수 있고, 테스트할 수 있는 UI를 제공하여 편리하게 테스트를 할 수 있다

 

- 사용 시 주의 사항

: API 문서 URL을 알고 있으면 제 3자가 외부에서 테스트를 할 수 있기 때문에 접근 권한의 제한을 두어 권한이 있는 사용자만 접근할 수 있도록 해야한다

 

 

 

 

swagger의 기능

- API Design (API 설계)

: Swagger-editor를 통해 api를 문서화 및 명세 가능

 

- API Develeopment

: Swagger-codepen을 통해 작성된 문서로 SDK를 생성하여 빌드 프로세스를 간소화

 

- API Documentation

: Swagger-UI를 통해 작성된 API를 시각화

 

- API Testing

: Swagger-Inspector를 통해 API를 시각화하고 빠른 테스팅 진행

 

- Standardize

: Swagger-hub를 통해 개인, 팀원들이 API 정보를 공유

 

 

 

 

Swagger 설치

- 공식 레포지터리

https://github.com/swagger-api/swagger-ui

GitHub - swagger-api/swagger-ui: Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beauti

: git clone을 받아서 프로젝트 내에 다운로드

: 다운로드 받은 파일 중 dist 디렉터리를 제외하고 전부 삭제

: dist 디렉터리를 프로젝트 내 원하는 곳으로 이동

 

- 테스트를 위한 라이브러리 세팅

// 로컬에서의 테스트를 위해 http-server 라이브러리에 cors를 허용
npm http-server --cors

: https://www.npmjs.com/package/http-server

 

- dis 디렉터리 내 index.html을 실행하여 설치 확인

 

 

 

 

 

 

 

Reference

Swagger로 API 문서 자동화를 해보자

Swagger란?

[Swagger] Swagger UI를 활용한 내부 API Client 구축