SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
来源:互联网 发布:phpcms 模板使用php 编辑:程序博客网 时间:2024/06/09 21:40
转载请标明出处:
http://blog.csdn.net/forezp/article/details/71023579
本文出自方志朋的博客
首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,为了springboot系列的完整性,所以标了个题。
一、apidoc简介
apidoc通过在你代码的注释来生成api文档的。它对代码没有侵入性,只需要你写好相关的注释即可,并且它仅通过写简单的配置就可以生成高颜值的api接口页面。它基于node.js,所以你需要安装node.js环境。node.js安装,点击这里。这里就不介绍。
二、准备工作
安装完node.js安装api.doc,它的项目源码:https://github.com/apidoc/apidoc 。
通过命令安装:
npm install apidoc -g
三、注释怎么写
- @api
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
- @apiDescription
- 1
- 2
- 1
- 2
- @apiError
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- @apiGroup
- 1
- 2
- 3
- 1
- 2
- 3
更多注释,参见官方文档:http://apidocjs.com/#params
四、写给栗子
首先写配置文件
在项目的主目录新建一个apidoc.json文件:
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
更多配置参考:http://apidocjs.com/#configuration
写个注释:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
用apidoc命令生成文档界面
先cd到工程的外层目录,并在外层目建个输出文档的目录,我建的是docapi。
输命令:
apidoc -i chapter4/ -o apidoc/
-i 输入目录 -o 输出目录
chapter4是我的工程名。
可以看到在apidoc目录生成了很多文件:
打开index.html,可以看到文档页面:
五、参考资料
apidoc
apidocjs.com
使用apidoc 生成Restful web Api文档
阅读全文
0 0
- SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
- SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
- SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
- SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
- SpringBoot非官方教程 | 第十三篇:springboot集成spring cache
- SpringBoot非官方教程 | 第十三篇:springboot集成spring cache
- SpringBoot非官方教程 | 第十三篇:springboot集成spring cache
- SpringBoot非官方教程 | 第十三篇:springboot集成spring cache
- SpringBoot非官方教程 | 第二十一篇: springboot集成JMS
- SpringBoot非官方教程 | 第二十一篇: springboot集成JMS
- SpringBoot非官方教程 | 第二十一篇: springboot集成JMS
- SpringBoot非官方教程 | 第二十一篇: springboot集成JMS
- SpringBoot非官方教程 | 第十七篇:上传文件
- SpringBoot非官方教程 | 第二十三篇: 异步方法
- SpringBoot非官方教程 | 第十七篇:上传文件
- SpringBoot非官方教程 | 第二十三篇: 异步方法
- SpringBoot非官方教程 | 第十七篇:上传文件
- SpringBoot非官方教程 | 第二十三篇: 异步方法
- 数据分析(入门篇)-第一章-数据分析那些事儿
- Thinkphp5学习(26)调试和日志
- JustOj1227: 统计单词个数
- jQuery初始化
- python中的单例模式
- SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
- 深入理解JVM(五)——JVM调优 Eclipse调优
- Atcoder ARC 077 E
- 杨辉三角的多解(转载)
- Android自定义控件时的事件处理方法
- ida android incompatible debugger server protocol version is 17,expected 19
- Java之字符流、字符缓冲流
- 1121: [POI2008]激光发射器SZK
- Opencv3.2+opencv_contrib+VS2015配置问题汇总