🚀 Gettler 的个人博客

Appearance

编写美观的接口文档 ​

Controller层：导出Swagger文档 ​

点击这里

image-20220703222215455

出现下图所示

image-20220703222729817

ctrl + a , ctrl + c复制全部后打开DocWay

点击新增，导入

image-20220703223526229

选择导入Swagger，点击粘贴Swagger内容，将刚才复制的一大堆数据粘贴进来，点击导入

image-20220703223559793

打开新增的项目

image-20220703223736626

右上角的更多功能中选择导出项目便可以导出离线的接口文档啦

image-20220703223926629

非常美观

im13g

Service层：使用Idea生成JavaDoc ​

打开idea，在这里生成JavaDoc

image-20220703224614026

-encoding UTF-8 -charset UTF-8

点击生成即可

image-20220703225946223

打开index.html，文档如下

image-20220703225901466

数据库：Screw ​

添加依赖

xml
<!-- 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>

编写测试类

java
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();
  }
}

运行即可生成文档

image-20220704084915464