superJavaDoc 快速文档构建框架

谙忆 2021-01-21 14:37:30
快速 框架 文档 构建 superjavadoc


superJavaDoc 快速文档构建框架

  • 基于Java注释生成接口文档
  • 注释支持扩展
  • 接口框架支持扩展
  • 默认支持markdown和离线/在线html等格式的文档
  • 默认支持spring mvc规范
  • 默认支持spring-boot直接内嵌启动

基于SpringBoot在线直接使用

1.引入Maven依赖

<!--加入maven依赖-->
<dependency>
<groupId>com.uifuture</groupId>
<artifactId>super-java-doc-starter</artifactId>
<version>1.0.0</version>
</dependency>

2.增加EnableDoc注解

在Application类上加上EnableDoc注解

@EnableDoc //<--- 加上此注解以便启用XDOC在线HTML文档
@SpringBootApplication
public class TestApplication {
public static void main(String[] args) {
SpringApplication.run(TestApplication.class, args);
}
}

3.1 properties配置文件

#在application.properties配置项目源码的位置,直接在项目里启动时,如果是单模块的maven项目,默认可以不配置
#是否启动XDoc,默认是true,因为可以不填
doc.enable=true
#源码路径,多个时用英文逗号隔开,super-java-doc-test为项目模块名称。单模块项目可以将super-java-doc-test/去掉,直接使用src/main/java
doc.sourcePath=super-java-doc-test/src/main/java
#用于配置文档页面标题
doc.title=在线接口文档
#标识接口文档的版本号
doc.version=1.0 

3.2 yml配置文件

doc:
enable: true #是否启动superJavaDoc,默认是true,因为可以不填
title: 在线接口文档 #用于配置文档页面标题
sourcePath: super-java-doc-test/src/main/java #源码路径,多个时用英文逗号隔开
version: 1.0 #标识接口文档的版本号

4 使用

以上配置就都写好了

跟着随便写几个Controller作为Demo接口,便于直接浏览生成效果:

/**
* BlogsController
*
* @author chenhaoxiang
* @date 2018-09-12 18:23:40
*/
@Controller
@RequestMapping("admin/blogs")
public class BlogsController {
@Resource
private BlogsService blogsService;
/**
* 添加Blogs
*
* @param blogs 对象
* @return ResultModel统一响应结果
*/
@PostMapping("add")
@ResponseBody
public ResultModel add(Blogs blogs) {
blogsService.insert(blogs);
return ResultModel.success();
}
/**
* 根据ID进行删除
*
* @param id 主键
* @return ResultModel统一响应结果
*/
@PostMapping("delete")
@ResponseBody
public ResultModel delete(@RequestParam Integer id) {
blogsService.deleteById(id);
return ResultModel.success();
}
/**
* 根据ID进行修改Blogs对象
*
* @param blogs 对象中必须有ID主键
* @return ResultModel统一响应结果
*/
@PostMapping("update")
@ResponseBody
public ResultModel update(Blogs blogs) {
blogsService.updateById(blogs);
return ResultModel.success();
}
/**
* 查询详情
*
* @param id 主键
* @return ResultModel统一响应结果
*/
@PostMapping("detail")
@ResponseBody
public ResultModel detail(@RequestParam Integer id) {
Blogs blogs = blogsService.selectById(id);
return ResultModel.success(blogs);
}
/**
* 分页查询
*
* @param page 当前页 默认0 不分页
* @param size 每页的条数 默认为0 查询所有
* @return ResultModel统一响应结果
*/
@PostMapping("list")
@ResponseBody
public ResultModel list(@RequestParam(defaultValue = "0") Integer page, @RequestParam(defaultValue = "0") Integer size) {
PageHelper.startPage(page, size);
List<Blogs> list = blogsService.selectAll();
PageInfo pageInfo = new PageInfo(list);
return ResultModel.success(pageInfo);
}
}

直接启动项目, 敲入地址: http://localhost:8080/superJavaDoc/index.html

如下两个图,为部分展示内容。

2.生成离线文档

支持html:

@Test
public void buildMarkdown() {
//生成离线的Markdown格式的接口文档
ByteArrayOutputStream out = new ByteArrayOutputStream();
String rootDir = System.getProperty("user.dir");
SuperJavaDoc xDoc = new SuperJavaDoc(rootDir + "/src/main/java/com/uifuture", new SpringWebFramework());
xDoc.build(out, new MarkdownFormat());
System.out.println(out.toString());
}

支持markdown:

@Test
public void buildHtml() throws Exception {
//生成离线的HTML格式的接口文档
String userDir = System.getProperty("user.dir");
FileOutputStream out = new FileOutputStream(new File(userDir, "api.html"));
SuperJavaDoc xDoc = new SuperJavaDoc(userDir + "/src/main/java/com/uifuture", new SpringWebFramework());
xDoc.build(out, new HtmlForamt());
}

注意:生产环境不推荐开启此文,可能会消耗性能,所以在生成环境下,配置文件中配置如下即可:

doc.enable=false

项目地址:https://github.com/chenhaoxiang/super-java-doc

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

版权声明
本文为[谙忆]所创,转载请带上原文链接,感谢
https://cloud.tencent.com/developer/article/1777348

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云