아구몬

RESTful 개발 도구 📋 ▻ swagger

October 01, 2019

logo

개발자가 RESTful 웹 서비스를 설계, 빌드, 문서화를 도와주는 프레임 워크

💎 목차

⚙️ 설치를 하며

$ npm install express

$ npm install swagger-jsdoc

$ npm install swagger-ui-express

⬆ 목차

😳 코드를 보며

▸ app.js

1

app.use() 라우트 경로 지정 할때,

swaggerUi.serve, swaggerUi.setup(swaggerJSDoc() swaager 환경 파일 지정


▸ /lib/swagger.js

2

  • components 응답 스키마를 정의
  • definitions Models 정의
  • apis request 라우터 경로

▸ /routes/index.js

3 

/**
 * @swagger         { swagger 지정 }
 * /:               { 요청 경로 }
 *  get:            { 요청 메소드 }
 *   summary: text  { 간략 설명 }
 *   tags: [Index]  { 태그 }
 *   responses:     { 응답 데이터 swagger 참고}
 *       200:
 *           $ref: '#/components/res/Ok'
 *       204:
 *           $ref: '#/components/res/NoContent'
 *       500:
 *           $ref: '#/components/res/InternalServerError'
 */

경로를 통해 데이터를 요청해서 해당 응답 코드에 맞게 제공



Swagger UI를 통한 결과물이다.


⬆ 목차

🤔 생각해 보며


  • USER 유저 API, BOARD 게시글 API 예시입니다.
  • 소스를 이해하고 개선하면서 추후에는 DATABASE도 연동해보시길 바랍니다.
  • 혹여 더 좋은 방법이 있으시면 공유도 부탁드립니다.

⬆ 목차


출처

GitHub > swagger

여러분의 댓글이 큰힘이 됩니다. (๑•̀ㅂ•́)و✧

Written by@[AGUMON]
아구몬 기술 블로그

GitHubFacebook