swagger ui 문서 정리

swagger 사용해보니 좀 생각보다 복잡하네.

정확히 복잡이라는 것보단 뭐가 너무 많다? 문서정리에 생각보다 시간이 너무 아깝지만 그렇다고 안할 수도 없는 노릇..

 

그냥 예시를 만들어두고 두고두고 추가해가면서 써야겠음...

 

post

/**
 * @swagger
 * /users/login:
 *  post:
 *    summary: "유저 로그인"
 *    description: "id, password 필수 입력"
 *    tags: [Users]
 *    parameters:
 *      - in: body
 *        name: login
 *        required: true
 *        description: 유저 아이디
 *        schema:
 *          type: object
 *          required:
 *            - user_id
 *            - user_password
 *          properties:
 *            user_id:
 *              type: string
 *              example: testId
 *            user_password:
 *              type: string
 *              example: example data
 *    responses:
 *      "200":
 *        description: 사용자가 서버로 전달하는 값에 따라 결과 값은 다릅니다. (유저 조회)
 *        content:
 *          application/json:
 *            schema:
 *              type: object
 *              properties:
 *                ok:
 *                  type: boolean
 *      "404":
 *        description: 사용자가 검색시 데이터가 없거나, 잘못된 url을 호출 하는 경우에 발생합니다.
 *        contents:
 *          application/json:
 *            schema:
 *              type: object
 *              properies:
 *                ok:
 *                  type: boolean
 *      "500":
 *        description: 서버의 상태나, 잘못된 경로로 호출이 되었을 경우
 */

 

get 인자값이 없이 토큰만 들어오는 경우

/**
 * @swagger
 * /users/me:
 *  get:
 *    summary: "유저 정보 및 토큰 확인용"
 *    description: "토큰을 전달하면 회원의 정보 및 토큰을 발행."
 *    tags: [Users]
 *    responses:
 *      "200":
 *        description: 사용자가 서버로 전달하는 값에 따라 결과 값은 다릅니다. (유저 조회)
 *        content:
 *          application/json:
 *            schema:
 *              type: object
 *              properties:
 *                ok:
 *                  type: boolean
 *      "404":
 *        description: 사용자가 검색시 데이터가 없거나, 잘못된 url을 호출 하는 경우에 발생합니다.
 *        contents:
 *          application/json:
 *            schema:
 *              type: object
 *              properies:
 *                ok:
 *                  type: boolean
 *      "500":
 *        description: 서버의 상태나, 잘못된 경로로 호출이 되었을 경우
 */

get 의 경우 query string으로 값을 받는 경우

이 경우는 작성중인 내용이라 추후 수정 예정. 후훗..

/**
 * @swagger
 * /client-companies/company-add:
 *  get:
 *    summary: "클라이언트 컴퍼니(회사) API"
 *    description: "로그인 후 토큰을 입력받고 호출"
 *    tags: [client companies]
 *    parameters:
 *      - in: query
 *        name: pageIdx
 *        type: integer
 *        description: 페이지인덱스 입력을 안할 시 기본값 1
 *        default: 1
 *        schema:
 *          properties:
 *            pageIdx:
 *              type: integer
 *              example: 1
 *
 *    responses:
 *      "200":
 *        description: 사용자가 서버로 전달하는 값에 따라 결과 값은 다릅니다. (유저 조회)
 *        content:
 *          application/json:
 *            schema:
 *              type: object
 *              properties:
 *                ok:
 *                  type: boolean
 *      "404":
 *        description: 사용자가 검색시 데이터가 없거나, 잘못된 url을 호출 하는 경우에 발생합니다.
 *        contents:
 *          application/json:
 *            schema:
 *              type: object
 *              properies:
 *                ok:
 *                  type: boolean
 */

개인 프로젝트에서 백엔드를 해보니까 생각보다 너무 재밌는걸..

 

문제는 잠이 안와서 이러고 있는... 내가 문제다..문제야..

내일 공장가서 좀 할 일 많은데...하;