https://apidocjs.com/#param-api-body
apiDoc - Inline Documentation for RESTful web APIs
<!-- /* ============================================================ * Demo * ============================================================ */ --> Demo This is an example documentation: <!-- /* ============================================================ *
apidocjs.com
샘플
https://apidocjs.com/example/#api-_header
Custom apiDoc browser title
apidocjs.com
- @api : method 와 호출 url, 액션 명 정의
- @apiName : 검색에 사용되는 액션명
- @apiGroup: 좌측 액션 그룹 ( 주문, 상품 등... )
- @apiVersion : 현재 api 버전. ( 버전관리 가능 )
- @apiDescription : 해당 api 설명
- @apiHeader : 헤더가 사용되는경우 헤더 정의
- @apiHeaderExample : 헤더 사용예시
- @apiParam : 파라미터 정의
- @apiParamExample : 파라미터 사용예시
- @apiSuccess : 성공결과정보 정의
- @apiSuccessExample : 성공결과 예시
- @apiError : 실패 결과정보 정의
- @apiErrorExample : 실패결과 예시