• A+

java 自动生成api 文档 :apidoc

官网:apidocjs

 

首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,适用于java项目。跟已有的项目框架没有任何关系

一、apidoc简介

apidoc通过在你代码的注释来生成api文档的。它对代码没有侵入性,只需要你写好相关的注释即可,并且它仅通过写简单的配置就可以生成高颜值的api接口页面。它基于node.js,所以你需要安装node.js环境。node.js安装,点击这里。这里就不介绍。

二、准备工作

安装完node.js安装api.doc,它的项目源码:https://github.com/apidoc/apidoc 。

 

通过命令安装:

npm install apidoc -g

 

运行apidoc -i chapter4/ -o apidoc/

 

就能自动生成项目api文档,避免写文档的麻烦

 

只要在项目api方法上面加上注释

/**

* @api {get} /user/:id  用户登录查询用户信息

* @apiName GetUser

* @apiGroup User

*

* @apiParam {Number} id Users unique ID.

*

* @apiSuccess {String} firstname Firstname of the User.

* @apiSuccess {String} lastname  Lastname of the User.

* @apiParam {int} vip = 0  是否注册Vip身份 0 普通用户 1 Vip用户

* @apiParamExample {json} 请求样例:

*                ?/user/:10061

* @apiSuccessExample Success-Response:

*    HTTP/1.1 200 OK

*    {

*      "firstname": "John",

*      "lastname": "Doe"

*    }

*

*/


注意:本文归作者所有,未经作者允许,不得转载
所属分类:架构

全部评论: 0

    我有话说:
    ×