一些好用的文档工具

简洁好用的数据库表结构文档工具

支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。 

https://gitee.com/leshalv/screw

<!--screw需要的依赖-->
       <dependency>
           <groupId>cn.smallbun.screw</groupId>
           <artifactId>screw-core</artifactId>
           <version>1.0.5</version>
       </dependency>

public static void main(String[] args){
        new GeneralDoc().documentGeneration();
    }
    /**
     * 文档生成
     */
    private void documentGeneration() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/mp?serverTimezone=UTC&zeroDateTimeBehavior=round&allowMultiQueries=true");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("zyy010907");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("F:\\Gx")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("数据库设计文档").build();

        //忽略表
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("test_user");
        ignoreTableName.add("test_group");
        //忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
        ignorePrefix.add("test_");
        //忽略表后缀
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        ignoreSuffix.add("_test");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.2")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
        //执行生成
        new DocumentationExecute(config).execute();
    }

<dependency>  
 	<groupId>io.springfox</groupId>    
	<artifactId>springfox-boot-starter</artifactId>   
 	<version>3.0.0</version> 
</dependency>

@Configuration

public class Swagger3Config {
    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.OAS_30) 
                .apiInfo(apiInfo()).select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger3接口文档")
                .description("接口文档")
                .contact(new Contact("张应杨", "#", "1113710198@qq.com"))
                .version("0.1.0")
                .build();
    }
}

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.
                addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
                .resourceChain(false);
    }

    /**
     * 此处是为了方便浏览器只用敲缀,方便访问
     * 本准备使用forward模式，发现forward过去swagger的静态文件访问不了
     * swagger静态文件是按照请求路径加载的，这个后续可以想办法在优化
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/swagger")
                .setViewName("redirect:/swagger-ui/index.html");
    }
}

registry.addInterceptor(new JWTInterceptor())
               .addPathPatterns("/**")
               .excludePathPatterns("/swagger-ui/**")
               .excludePathPatterns("/swagger-resources/**")
               .excludePathPatterns("/swagger-ui.html/**")
               .excludePathPatterns("/webjars/**")
               .excludePathPatterns("/**/v3/api-docs")
               .excludePathPatterns("/swagger/**");

[yum源名称]
name=google-chrome
baseurl=http://dl.google.com/linux/chrome/rpm/stable/x86_64
enabled=1
gpgcheck=1
gpgkey=https://dl.google.com/linux/linux_signing_key.pub