使用apidoc 生成Restful web Api文档
2017-12-18 16:26
501 查看
该工具是Nodejs的模块,请务必在使用前安装好nodejs环境!
工具名称:apiDoc
Git地址:https://github.com/apidoc/apidoc
项目地址:http://apidocjs.com/
样例项目:http://apidocjs.com/example_basic/
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮漂亮的……
安装apiDoc
配置
无package.json文件时,需要在代码文件夹的根目录下,创建apidoc.json文件。
在该文件中即可配置apidoc
有package.json文件时,在package.json文件中添加”apidoc”: { }属性即可。
配置属性如下:
参数说明:
-f 文件过滤
使用正则表达式,表示哪些文件需要本转换,不设置的情况下,默认为.cs .dart .erl .go .java .js .php .py .rb .ts 后缀的文件。
-i 代码文件夹
-o 输出Api文档的路径
-t 使用模板文件的路径,可以自定义输出的模板
常用的命令格式如下:
工具名称:apiDoc
Git地址:https://github.com/apidoc/apidoc
项目地址:http://apidocjs.com/
样例项目:http://apidocjs.com/example_basic/
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮漂亮的……
安装apiDoc
npm install apidoc -g
配置
无package.json文件时,需要在代码文件夹的根目录下,创建apidoc.json文件。
{ "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1" }
在该文件中即可配置apidoc
有package.json文件时,在package.json文件中添加”apidoc”: { }属性即可。
{ "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "apidoc": { "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1" } }
配置属性如下:
name:项目名称 version:项目版本 description:项目介绍 title:浏览器显示的标题内容 url:endpoints的前缀,例如https://api.github.com/v1 sampleUrl:如果设置了,则在api文档中出现一个测试用的from表单 header title:导航文字包含header.md文件 filename:markdown-file 文件名 footer title:导航文字包含header.md文件 filename:markdown-file 文件名 order:用于配置输出 api-names/group-names 排序,在列表中的将按照列表中的顺序排序,不在列表中的名称将自动显示。
参数说明:
-f 文件过滤
使用正则表达式,表示哪些文件需要本转换,不设置的情况下,默认为.cs .dart .erl .go .java .js .php .py .rb .ts 后缀的文件。
-i 代码文件夹
-o 输出Api文档的路径
-t 使用模板文件的路径,可以自定义输出的模板
常用的命令格式如下:
apidoc -i myapp/ -o apidoc/
相关文章推荐
- 使用apidoc 生成Restful web Api文档——新手问题与解决方法
- 使用apidoc 生成Restful web Api文档
- 使用apidoc 生成Restful web Api文档
- Web API文档生成工具apidoc 的使用步骤
- apidoc 生成Restful web Api文档
- 使用apidoc生成restful-api文档:安装nodejs+npm+apidoc
- apidoc 生成Restful web Api文档
- apidoc 生成Restful web Api文档
- ASP.NET Core 中文文档 第二章 指南 (09) 使用 Swagger 生成 ASP.NET Web API 在线帮助测试文档
- 使用Swagger整合SpringMVC自动生成Restful接口文档
- ASP.NET Web API 使用Swagger生成在线帮助测试文档
- 使用swagger作为restful api的doc文档生成——从源码中去提取restful URL接口描述文档
- Web API 自动生成帮助文档并使用Web API Test Client 测试
- Web API文档生成工具apidoc
- Web API文档生成工具apidoc
- Web API文档生成工具apidoc
- ASP.NET Web API 使用Swagger生成在线帮助测试文档
- ASP.NET Web API 使用Swagger生成在线帮助测试文档,支持多个GET
- ASP.NET Web API 使用Swagger生成在线帮助测试文档
- 在Spring中使用Springfox和swagger生成restful风格的API文档