Learn to use code to generate beautiful interface documents!!!

Write beautiful interface documents

Controller layer ： export Swagger file

Click here

As shown in the figure below

ctrl + a , ctrl + c Open after copying all DocWay

Click Add , Import

Select import Swagger, Click Paste Swagger Content , Paste in a lot of data just copied , Click Import

Open the new project

Select export project in the more functions in the upper right corner to export offline interface documents

Very beautiful

Service layer ： Use Idea Generate JavaDoc

open idea, Generate... Here JavaDoc

-encoding UTF-8 -charset UTF-8

Click generate

open index.html, The documents are as follows

database ：Screw

Add dependency

<!-- screw Screw core  -->
<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.3</version>
</dependency>
<!-- HikariCP  Database connection pool  -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>3.4.5</version>
</dependency>

Writing test classes

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);

        //  Generate file configuration 
        EngineConfig engineConfig = EngineConfig.builder()
                //  Generate file path 
                .fileOutputDir("D:/")
                //  Open Directory 
                .openOutputDir(true)
                //  file type 
                .fileType(EngineFileType.HTML)
                //  Generate template implementation 
                .produceType(EngineTemplateType.freemarker).build();
        //  Generate document configuration （ Include the following custom version number 、 Description, etc ）
        Configuration config = Configuration.builder().version("V1").description(" Database documents ").dataSource(dataSourceMysql).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();
        //  Perform build 
        new DocumentationExecute(config).execute();
    }

    /** *  Configure the table you want to generate +  Configure the tables you want to ignore  * * @return  Build table configuration  */
    public static ProcessConfig getProcessConfig() {
    
// //  Ignore table name 
// List<String> ignoreTableName = Arrays.asList("dept", "dept1");
// //  Ignore table prefix , If you ignore a The first database table 
// List<String> ignorePrefix = Arrays.asList("dept", "dept1");
// //  Ignore table suffix 
// List<String> ignoreSuffix = Arrays.asList("dept", "dept1");
        return ProcessConfig.builder()
                // Specify a table by name to generate 
// .designatedTableName(Arrays.asList("tb_his_prescription_record_extend", "tb_his_prescription_detail_extend"))
                // Generate according to the table prefix 
                .designatedTablePrefix(new ArrayList<>())
                // Generate from table suffix 
                .designatedTableSuffix(new ArrayList<>()).build();
        // Ignore table name 
// .ignoreTableName(ignoreTableName)
        // Ignore table prefix 
// .ignoreTablePrefix(ignorePrefix)
        // Ignore table suffix 
// .ignoreTableSuffix(ignoreSuffix).build();
    }
}

Run to generate documents