라이브러리 | API 문서 생성기 스웨거(Swagger)

API 명세는 다음의 조건을 만족해야 합니다

• 프론트와 백엔드가 모두 접근 가능해야함
• 수정이 용이해야함
• 문서와 코드는 항상 동일해야함

직접 사람이 문서(Documents) 를 만들게 되면 놓치는 일이 생길 수밖에 없습니다. 반면 스웨거는 자동으로 업데이트 하는 장점을 가지고 있습니다

스웨거 : 바로가기

설치할 때 두가지 방법이 있습니다.

• dependencies : 개발, 배포과정 전체에서 사용
• devDependencies : 개발 과정에서만 사용 가능

요약

노드 JS 설치법

• swagger-cli : yaml 을 병합합니다.
• swagger-ui-express : 작성해둔 API 명세를 UI로 보여줍니다.
• yamljs : 타입스크립트(TS) 파일로 yaml을 읽습니다.

npm install swagger-cli swagger-ui-express yamljs
npm install -D @types/swagger-ui-express @types/yamljs

PHP 설치법

swagger-php 깃허브 : 바로가기

composer require zircote/swagger-php

설치할 때 위의 링크를 통해 작업하면 더욱

자바 사용법

implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

build.gradle 에 위의 코드를 추가합니다.

대체 프로그램

• 레스트 독스 : 스프링 전용 문서 라이브러리 [링크]