인터페이스 문서 생 성 도구 - apidoc
1196 단어 자바 script
사용 방법
저희 가 express 프로젝트 를 예 로 들 면...
1 apidoc. json 만 들 기
{
"name": "abc api ",
"version": "1.0.0",
"description": " ",
"title": "abc api ",
"url" : "localhost:3000/api",
"template": {
"withCompare": true,
"withGenerator": true
}
}2. 저 희 는 routes 폴 더 에서 api 폴 더 를 만 들 고 인터페이스 설명 을 작성 합 니 다. 예 를 들 어
/**
* @api {get} /news/newsContent
* @apiVersion 1.0.0
* @apiName newsContent
* @apiGroup news
* @apiParam {Number} id id
* @apiSuccess {Number} code
* @apiSuccess {String} message
* @apiSuccess {Object} data
* @apiSuccessExample Success-Response:
* HTTP/11 200 OK
* {
* "code": 1,
* "mess": " ",
* "data": {}
* }
*/ 3 호출 생 성 명령
apidoc -i routes/ -o public/apidoc/이상 명령 은 routes 폴 더 의 api 설정 을 읽 고 api 설명 문 서 를 Public / apidoc / 폴 더 로 출력 하여 생 성 된 index. html 를 열 면 됩 니 다.
이 내용에 흥미가 있습니까?
현재 기사가 여러분의 문제를 해결하지 못하는 경우 AI 엔진은 머신러닝 분석(스마트 모델이 방금 만들어져 부정확한 경우가 있을 수 있음)을 통해 가장 유사한 기사를 추천합니다:
Thymeleaf 의 일반 양식 제출 과 AJAX 제출텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
CC BY-SA 2.5, CC BY-SA 3.0 및 CC BY-SA 4.0에 따라 라이센스가 부여됩니다.
좋은 웹페이지 즐겨찾기
