Super Javadoc fast document construction framework

Familiar with memory 2021-01-21 14:37:51
super javadoc fast document construction


superJavaDoc Quick document building framework

  • be based on Java Comments generate interface documents
  • Annotations support extensions
  • The interface framework supports extensions
  • The default support markdown And offline / On-line html Document of equal format
  • The default support spring mvc standard
  • The default support spring-boot Direct inline boot

be based on SpringBoot Online direct use

1. introduce Maven rely on

<!-- Join in maven rely on -->
<dependency>
<groupId>com.uifuture</groupId>
<artifactId>super-java-doc-starter</artifactId>
<version>1.0.0</version>
</dependency>

2. increase EnableDoc annotation

stay Application Class plus EnableDoc annotation

@EnableDoc //<--- Add this annotation to enable XDOC On-line HTML file
@SpringBootApplication
public class TestApplication {
public static void main(String[] args) {
SpringApplication.run(TestApplication.class, args);
}
}

3.1 properties The configuration file

# stay application.properties Configuration project source location , When starting directly in a project , If it's a single module maven project , By default, it can not be configured
# Whether to start XDoc, The default is true, Because you don't have to fill in
doc.enable=true
# Source path , Separate them with commas ,super-java-doc-test Name the project module . A single module project can put super-java-doc-test/ Get rid of , Use it directly src/main/java
doc.sourcePath=super-java-doc-test/src/main/java
# Used to configure document page titles
doc.title= Online interface documentation
# Identify the version number of the interface document
doc.version=1.0 

3.2 yml The configuration file

doc:
enable: true # Whether to start superJavaDoc, The default is true, Because you don't have to fill in
title: Online interface documentation # Used to configure document page titles
sourcePath: super-java-doc-test/src/main/java # Source path , Separate them with commas
version: 1.0 # Identify the version number of the interface document 

4 Use

The above configuration is all written

Just write a few Controller As Demo Interface , Easy to browse directly to generate effect :

/**
* BlogsController
*
* @author chenhaoxiang
* @date 2018-09-12 18:23:40
*/
@Controller
@RequestMapping("admin/blogs")
public class BlogsController {
@Resource
private BlogsService blogsService;
/**
* add to Blogs
*
* @param blogs object
* @return ResultModel Unified response results
*/
@PostMapping("add")
@ResponseBody
public ResultModel add(Blogs blogs) {
blogsService.insert(blogs);
return ResultModel.success();
}
/**
* according to ID To delete
*
* @param id Primary key
* @return ResultModel Unified response results
*/
@PostMapping("delete")
@ResponseBody
public ResultModel delete(@RequestParam Integer id) {
blogsService.deleteById(id);
return ResultModel.success();
}
/**
* according to ID Make changes Blogs object
*
* @param blogs Object must have ID Primary key
* @return ResultModel Unified response results
*/
@PostMapping("update")
@ResponseBody
public ResultModel update(Blogs blogs) {
blogsService.updateById(blogs);
return ResultModel.success();
}
/**
* Query details
*
* @param id Primary key
* @return ResultModel Unified response results
*/
@PostMapping("detail")
@ResponseBody
public ResultModel detail(@RequestParam Integer id) {
Blogs blogs = blogsService.selectById(id);
return ResultModel.success(blogs);
}
/**
* Paging query
*
* @param page The current page Default 0 No paging
* @param size Number of entries per page The default is 0 Query all
* @return ResultModel Unified response results
*/
@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);
}
}

Start the project directly , Type in the address : http://localhost:8080/superJavaDoc/index.html

Here are two pictures , Part of the presentation .

2. Generate offline documents

Support html:

@Test
public void buildMarkdown() {
// Generate offline Markdown Format interface document
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());
}

Support markdown:

@Test
public void buildHtml() throws Exception {
// Generate offline HTML Format interface document
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());
}

Be careful : The production environment does not recommend opening this article , May consume performance , So in a generative environment , The configuration file can be configured as follows :

doc.enable=false

Project address :https://github.com/chenhaoxiang/super-java-doc

Participation of this paper Tencent cloud media sharing plan , You are welcome to join us , share .

版权声明
本文为[Familiar with memory]所创,转载请带上原文链接,感谢
https://javamana.com/2021/01/20210121143722190g.html

  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课程百度云