c语⾔api接⼝⽂档模板,apiDoc⽣成接⼝⽂档，不费吹灰之⼒
背景
之前做前端的时候，后端同学仗着⾃⼰是⽼同志，不给我接⼝⽂档
苦逼如我，需要拿着笔坐在他的旁边，听他⼝述
写下需要的api接⼝url和参数等等
现在⾃⼰做后端了，那不能这样⼦胡作⾮为了
⾃⼰吃的苦，怎能给其他同学吃呢?
这时候,apiDoc你值得拥有，稳稳的输出⼀篇优质的接⼝⽂档
安装apidoc
官⽹上是全局安装，我是喜欢安装到项⽬中，这样可以在另⼀个环境下, npm install 就可以下载有所有依赖包
npm install apidoc --save-dev/-D
复制代码
写注释
注册接⼝的注释
/**
* @api {post} /v1/auth/register User Register
* @apiName UserRegister
* @apiGroup userAuthentication
*
* @apiParam {String} username New user's username.
* @apiParam {String} password New user's password.
*
* @apiSuccess {String} username The username of the register user.
* @apiSuccess {string} message The registering success info.
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "username": "username",
* "message": "User registered successful"
* }
*
* @apiError REGISTER_FAILURE The register failure.
*
* @apiErrorExample Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "err": "REGISTER_FAILURE",
* "message": "User register failure!"
* }
*/
复制代码
删除接⼝的注释
/**
* @api {delete} /v1/auth/user/ User delete
* @apiName UserDelete
* @apiGroup userAuthentication
*
* @apiParam {String} username User's username.
* @apiParam {String} executor Executor of this operation.
*
* @apiSuccess {String} username The username of the deleted user. * @apiSuccess {string} message The message if deleting successful. *
* @apiSuccessExample Success-Response:
百度api接口* HTTP/1.1 200 OK
* {
* "username": "username",
* "message": "Delete User Successful"
* }
*
* @apiError NOT_LOGIN The register failure.
*
* @apiErrorExample Error-Response:
* HTTP/1.1 401 Unauthorized
* {
* "err": "NOT_LOGIN",
* "message": "User has not logon in!"
* }
*/
复制代码
写⼊命令
将 apidoc -i routers/ 写⼊package.json的命令中routers⽂件夹下都是路由⽂件
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "lint": "eslint .",
"apidoc": "apidoc -i routers/",
"dev": "node --harmony index.js"
},
复制代码
出现了 {"message":"Done.","level":"info"} ，即成功了
执⾏命令
执⾏ npm run apidoc 即可拿到接⼝⽂档
这样，在项⽬中就会出现 doc ⽂件夹
⽣成⽂档
这样, doc ⽂件夹中包含该页⾯的所有材料
打开 index.html
热乎乎的接⼝⽂档诞⽣了
结构解读
⼀个静态的⽂档很漂亮的⽣成了，但是实际控制这个⽅法的是api_data.js和api_project.js。但是实际上的数据显⽰是由api_data.json和api_project.json这两个 json ⽂件。
所以在⽀持将其他json格式转换成api_data.json和api_project.json，把apidoc⽣成的这两个⽂件进⾏替换，然后替换js⽂件，直接⽣产静态⽂档。
命令⾏界⾯
查看所有命令
apidoc -h
复制代码
选项
作⽤
-f --file-filters
⽤于选择应分析的⽂件的regex筛选器(可以使⽤多个-f)。(默认值：[])
-e, --exclude-filters
⽤于选择不应解析的⽂件/⽬录的regex筛选器(可以使⽤many-e)。(默认值：[])
-i, --input
输⼊/源⽬录名。(默认值：[])
-o, --output
输出⽬录。(默认：“./doc/”)
-
t, --template
对输出⽂件使⽤模板。(默认值：“/usr/local/lib/node_modules/apidoc/template/”)
-c, --config
包含配置⽂件(apidoc.json)的⽬录路径。(默认值：“./”)
-p, --private
Include private APIs in output.
-v, --verbose
详细调试输出。
--debug
显⽰调试消息。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。