Java—使用ApiDoc接口文档
之前写过使用Swagger编写Api接口文档，介绍了Java怎么使用Swagger做项目的Api接口文档。也百度过现在生成Api接口文档的工具,看到的都是Swagger或者是股指期货程序化交易接口,apidoc。
项目为什么需要Api接口文档：
因为前后端分离，需要前后端共同定义接口规范，在项目开发中需要有一个统一的文件进行更好的沟通。在项目开发结束之后，日常的项目维护和人员更替，都需要有文档来记录，方便后期人员查看并继续维护项目。
自动生成Api接口文档工具：
官网地址：https://swagger.io/
安装股指期货程序化交易接口,apidoc操作：
我这边先是手动安装的，然后在idea里面的也下载的股指期货程序化交易接口,apidoc的插件，我觉得应该不会有冲突问题。操作步骤如下。
手动安装：安装股指期货程序化交易接口,apidoc需要的软件：
确认当前电脑安装了nodjs。检测是否安装命令：
如果没有安装，点击nodjs下载安装。
安装股指期货程序化交易接口,apidoc
测试股指期货程序化交易接口,apidoc是否安装成功
idea插件安装：idea工具下载股指期货程序化交易接口,apidoc插件：
我的idea快捷键：Ctrl+Alt+s点击Plugins搜索股指期货程序化交易接口,apidoc
在idea下载插件过程中有无法下载的情况，请看操作步骤：
Ctrl + Alt + s
选择appearance&Behavior –> System Settings –> updates
去掉 Use secure connection 的勾选即可。
在idea中安装完股指期货程序化交易接口,apidoc插件以后，点击接口方法名按右键：
出现如下片，就可以编辑Api接口文档了。
自动生成股指期货程序化交易接口,apidoc接口文档操作：
新建股指期货程序化交易接口,apidojson文件位置如所示
{
'name': '接口说明文档'',
'version': '版本号',
'description': '项目描述',
'title': '浏览器标题',
'url': '测试地址',
}
带header示例
{
'name': '接口说明文档',
'version': '版本号',
'description': '项目描述',
'title': '浏览器标题',
'url':'测试地址',
'header': {
'title': '标题',
'filename': '内容文件'
},
'footer': {
'title': '',
'filename': ''
}
}
生成文档：
股指期货程序化交易接口,apidoc和swagger不同的是，接口文档和代码是分开的，当我们开发完成时，只需要在接口方法上加上股指期货程序化交易接口,apidoc指定的注释，最后通过命令生成文档。
生成完的文档：
这里没有讲股指期货程序化交易接口,apidoc的注释，有兴趣的朋友可以自己看一下下面的地址链接
文章为作者独立观点，不代表 股票程序化软件自动交易接口观点
相关文章
股民评论