当前位置:网站首页>学习使用代码生成美观的接口文档!!!
学习使用代码生成美观的接口文档!!!
2022-07-06 16:51:00 【Gettler•Main】
编写美观的接口文档
Controller层:导出Swagger文档
点击这里
出现下图所示
ctrl + a
, ctrl + c
复制全部后打开DocWay
点击新增,导入
选择导入Swagger,点击粘贴Swagger内容,将刚才复制的一大堆数据粘贴进来,点击导入
打开新增的项目
右上角的更多功能中选择导出项目便可以导出离线的接口文档啦
非常美观
Service层:使用Idea生成JavaDoc
打开idea,在这里生成JavaDoc
-encoding UTF-8 -charset UTF-8
点击生成即可
打开index.html,文档如下
数据库:Screw
添加依赖
<!-- screw螺丝钉核心 -->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.3</version>
</dependency>
<!-- HikariCP 数据库连接池 -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
编写测试类
package com.gettler.oa_team05.DataBaseOutput;
import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.Test;
import java.util.ArrayList;
public class DataSourceOutDemo {
@Test
public void test() {
// DataSource dataSourceMysql = SpringContextUtil.getBean(DataSource.class);
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/oa_team05?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8");
hikariConfig.setUsername("root");
hikariConfig.setPassword("73748156");
HikariDataSource dataSourceMysql = new HikariDataSource(hikariConfig);
// 生成文件配置
EngineConfig engineConfig = EngineConfig.builder()
// 生成文件路径
.fileOutputDir("D:/")
// 打开目录
.openOutputDir(true)
// 文件类型
.fileType(EngineFileType.HTML)
// 生成模板实现
.produceType(EngineTemplateType.freemarker).build();
// 生成文档配置(包含以下自定义版本号、描述等配置连接)
Configuration config = Configuration.builder().version("V1").description("数据库文档").dataSource(dataSourceMysql).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();
// 执行生成
new DocumentationExecute(config).execute();
}
/** * 配置想要生成的表+ 配置想要忽略的表 * * @return 生成表配置 */
public static ProcessConfig getProcessConfig() {
// // 忽略表名
// List<String> ignoreTableName = Arrays.asList("dept", "dept1");
// // 忽略表前缀,如忽略a开头的数据库表
// List<String> ignorePrefix = Arrays.asList("dept", "dept1");
// // 忽略表后缀
// List<String> ignoreSuffix = Arrays.asList("dept", "dept1");
return ProcessConfig.builder()
//根据名称指定表生成
// .designatedTableName(Arrays.asList("tb_his_prescription_record_extend", "tb_his_prescription_detail_extend"))
//根据表前缀生成
.designatedTablePrefix(new ArrayList<>())
//根据表后缀生成
.designatedTableSuffix(new ArrayList<>()).build();
//忽略表名
// .ignoreTableName(ignoreTableName)
//忽略表前缀
// .ignoreTablePrefix(ignorePrefix)
//忽略表后缀
// .ignoreTableSuffix(ignoreSuffix).build();
}
}
运行即可生成文档
边栏推荐
- rancher集成ldap,实现统一账号登录
- Random类的那些事
- Liuyongxin report | microbiome data analysis and science communication (7:30 p.m.)
- @TableId can‘t more than one in Class: “com.example.CloseContactSearcher.entity.Activity“.
- 37 pages Digital Village revitalization intelligent agriculture Comprehensive Planning and Construction Scheme
- uniapp实现从本地上传头像并显示,同时将头像转化为base64格式存储在mysql数据库中
- Leecode brushes questions to record interview questions 17.16 massagist
- Notes of training courses selected by Massey school
- MySQL master-slave multi-source replication (3 master and 1 slave) setup and synchronization test
- ZYNQ移植uCOSIII
猜你喜欢
48页数字政府智慧政务一网通办解决方案
What is AVL tree?
AI super clear repair resurfaces the light in Huang Jiaju's eyes, Lecun boss's "deep learning" course survival report, beautiful paintings only need one line of code, AI's latest paper | showmeai info
How engineers treat open source -- the heartfelt words of an old engineer
Everyone is always talking about EQ, so what is EQ?
37页数字乡村振兴智慧农业整体规划建设方案
@TableId can‘t more than one in Class: “com.example.CloseContactSearcher.entity.Activity“.
2021 SASE integration strategic roadmap (I)
沉浸式投影在线下展示中的三大应用特点
ldap创建公司组织、人员
随机推荐
【软件逆向-求解flag】内存获取、逆变换操作、线性变换、约束求解
Compilation of kickstart file
刘永鑫报告|微生物组数据分析与科学传播(晚7点半)
2022/2/11 summary
stm32F407-------DAC数模转换
Use Yum or up2date to install the postgresql13.3 database
Three sentences to briefly introduce subnet mask
【CVPR 2022】目标检测SOTA:DINO: DETR with Improved DeNoising Anchor Boxes for End-to-End Object Detection
Designed for decision tree, the National University of Singapore and Tsinghua University jointly proposed a fast and safe federal learning system
Memory optimization of Amazon memorydb for redis and Amazon elasticache for redis
GPIO簡介
【YoloV5 6.0|6.1 部署 TensorRT到torchserve】环境搭建|模型转换|engine模型部署(详细的packet文件编写方法)
509 certificat basé sur Go
Leecode brushes questions and records interview questions 01.02 Determine whether it is character rearrangement for each other
Policy Gradient Methods
Lombok 同时使⽤ @Data 和 @Builder 的坑,你中招没?
2022 PMP project management examination agile knowledge points (9)
48 page digital government smart government all in one solution
X.509 certificate based on go language
Introduction to GPIO