快速根据注释生成接口文档网页工具—

环境：

操作系统 CentOS Linux release 7.6.1810 (Core) 64位

服务器环境 “腾讯云”服务器

1，安装Node.js的npm工具环境：

如有不懂，请看我的博客：CentOS7 源码编译安装NodeJS 最新版本

2，npm环境搭好后，控制台运行命令：

npm install apidoc -g

等待安装完成

2，新建接口程序文件test.java 中添加apidoc文档注释

创建新目录

mkdir -p /data/apidoc/
cd /data/apidoc/

/data/apidoc目录新建文件test.java，内容如下：

/*** @apiDefine userApiStr 用户接口文档 *//*** @api {POST} /login 用户登录* @apiName api测试* @apiGroup userApiStr* @apiVersion 1.0.0* @apiDescription 用于用户登录* @apiParam {String} userName 用户名* @apiParam {String} password 密码* @apiParamExample {json} 请求样例：*                ?userName=张三&password=11223344* @apiSuccess (200) {String} msg 信息* @apiSuccess (200) {String} code 0 代表无错误 1代表有错误* @apiSuccess (200) {String} user 用户信息* @apiSuccess (200) {String} userId 用户id* @apiSuccessExample {json} 返回样例:*                {"code":"0","msg":"登录成功","userId":"fe6386d550bd434b8cd994b58c3f8075"}*/

3，生成apidoc文档，在当前注释文件目录下输入命令

apidoc -i /data/apidoc -o /data/apidoc
# apidoc    -i    注释文件所在目录路径     生成的apidoc文档所在目录路径

完成后显示了生成的apidoc文件目录：

打开 ”index.html“ 查看生成的接口文档

到这里，apidoc就成功跑起来了

快速根据注释生成接口文档网页工具——Apidoc的使用教程相关推荐

使用Sandcastle 基于代码注释生成接口文档
一. 工具下载: 1. Sandcastle:Sandcastle是微软官方的文档生成工具,下载地址:http://www.codeplex.com/Sandcastle 2. SHFBGuidedI ...
python生成接口文档_使用apiDoc实现python接口文档编写
使用apiDoc实现python接口文档编写 apiDoc的安装 npm install apidoc -g 生成api的终端命令:apidoc -i 代码所在路径-o 生成文件的路径接口文档的编写 ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
Apifox 生成接口文档教程与操作步骤
接口文档自动生成本文主要介绍使用 apifox 如何生成接口文档,附上详细的使用教程和操作步骤. 使用Apifox 的可以自动生成接口文档.本文会给大家介绍下如何使用Apifox 来自动生成所需的接 ...
axis2生成客户端代码_利用ApiPost一键、快速生成接口文档！女猿也过38节！
对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档. 我们可都是正个八经的理工校草和理工女神,研究github.逛逛csdn.写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?( ...
使用sphinx快速为你python注释生成API文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...
idea 快速生成接口文档
idea 快速生成接口文档之前使用过小幺鸡,swagger 感觉不太合适自己小幺鸡的话效率太慢了,每次都要复制生成好的json,如果接口做了修改,也要手动去修改小幺鸡的文档 swagger 的话 ...
开发必备工具，快速生成接口文档、调用示例、mock配置
前言开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档. 那要怎么快速的出接口文档.调用示例.mock呢?如果太麻烦,很多人就不愿意去写了. 今天给大家介绍一个 ...
使用Eolinker快速生成接口文档
提示:使用Eolinker快速生成接口文档文章目录前言一.ider下载easyapi插件? 二.使用步骤 1.首先生成json文件 2.将JSON文件导入到Eolinker,在Eolinker完 ...

快速根据注释生成接口文档网页工具——Apidoc的使用教程

快速根据注释生成接口文档网页工具——Apidoc的使用教程相关推荐

最新文章

热门文章