[Swagger] API 명세 관리, node.js

# Open API :  REST API를 위한 표준 API 명세 규격

최근에는 REST API로 많이 개발을 하는데, 전체 API 명세를 어떻게 하면 되는지 알려주고 있다.

yaml파일이나 json 형태로 endpoint, parameter, response 등 API 의 모든 내용을 표현해 준다.

swagger에서도 Open API를 지원한다.

 

# Swagger : Open Api Specification(OAS)를 위한 프레임워크

https://swagger.io/

API Documentation & Design Tools for Teams | Swagger

 

# 프로젝트에 독립적인 API docs 만들기

npm i swagger-ui-express swagger-jsdoc