Swagger 사용방법

https://swagger.io/docs/specification/paths-and-operations/

 

 

Swagger 의 데이터 형식은 YAML 을 이용한다.

• YAML작성법 참고: https://joey0203.tistory.com/114
• Swagger 공식문서 참고 : https://swagger.io/docs/specification/paths-and-operations/

Node.js 에서 사용 할때 설치 해야 할 라이브러리

npm i swagger-jsdoc swagger-ui-express

• https://www.npmjs.com/package/swagger-ui-express
• https://www.npmjs.com/package/swagger-jsdoc

작성시 주의 할점

- 공백을 잘 처리해서 구조화 해야한다. 탭 사용 X 스페이스바로 구별

- 내가 못 찾은 것일 수도 있지만 계층적 구조로 내려갈때 몇칸을 띄워서 구분하는지 설명이 없다..

    - 에러를 통해서 경험해본 결과 보통 1~2칸 으로 처리 하는 듯 하다.

 

예시

/**
 * @swagger
 * /maps/{station}:
 *   post:
 *     summary: station 위치 조회 및 맵에 표시
 *     description: 선택된 역에 있는 위치만 맵에 표시
 *     parameters:
 *      - in: path
 *        name: station
 *        required: true
 *        description :  the name and location of the station
 *        schema:
 *          type: string
 *
 *     responses:
 *       200:
 *         description: 조회 성공
 */
 
router.post('/:station', async (res, req) =>{
	res.status(200).send('test);
})

 

 

정말 어렵다고 여겨지는 것이 큰 틀이 없다.

위의 파라메터를 작성할 때 공식 문서에는 in: 부분이 먼저인데 name을 먼저 사용해도 아무 문제 없다.

띄어 쓰는것 도 상황에 따라 다른것 같다...

아직 모르겠다..... 공식 문서에서는 2칸씩 띄우니까 이대로 따라해야지

 

 

끝없이 에러가 발생한다면...
한 줄씩 작성하고 테스트하면서 에러를 줄여가자!!