环境
- springboot
- node.js
过程
1.首先你需要安装node.js,然后通过npm命令安装:npm install apidoc -g
备注:在执行命令之前,可以设置一下国内的镜像,下载起来会快一点的:npm config set registry https://registry.npm.taobao.org
2.创建一个springboot工程,写一个控制类
@RestController
@RequestMapping("/user")
public class UserController {
/**
* @api {Get} /user/add 添加User的接口
* @apiName 添加用户
* @apiGroup user
* @apiDescription 添加用户的接口
* @apiParam name 用户名
* @apiSuccess name
*/
@GetMapping("/add")
public String add(String name){
return name;
}
}
注释的参数需要这些参数
3.在当前项目的根目录下创建一个apidoc.json
文件
在里面配置一下信息
{
"name": "apidoc_demo",
"version": "0.1.0",
"description": "apidoc_demo",
"title": "apidoc",
"url" : "http://localhost:9999"
}
4.然后在当前项目的根目录下执行apidoc -i ./ -o ./doc
会在项目的根目录下创建doc文件夹,并且写入接口文档
打开index.html就可以访问了