# gdoc-core

**Repository Path**: yamed/gdoc-core

## Basic Information

- **Project Name**: gdoc-core
- **Description**: 接口文档生成工具，无需修改源代码。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 2
- **Created**: 2019-11-11
- **Last Updated**: 2022-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gdoc

#### 介绍
接口文档生成工具，目标项目无需做任何变更，便可一键生成接口文档。

#### 使用说明

1.  下载地址
    https://gitee.com/yamed/gdoc-core

2.  项目结构说明
    `gdoc` ：接口生成工具，开发只需用到它。  
    `demo`、`common`：生成接口的目标项目

3.  配置 tools.jar
    File -> Project Structure -> SDKs 添加jdk lib包下的 tools.jar 
    ![](https://gitee.com/yamed/gdoc-core/raw/master/tools.jpg)

4.  执行方法
    执行godc项目下的 AppMain 或者 GDocMain  
    application.properties 可配置的值，在GDocMain 内都可以赋值。
    
5.  结果查看
    登陆小幺鸡查看结果：  
    url：http://xyj.yamed.top/xiaoyaoji-2.1.7/  
    邮箱：root@163.com  
    密码：root  
    ![](https://gitee.com/yamed/gdoc-core/raw/master/xyj.jpg)
        
6.  gdoc的resources 配置说明  
    application.properties 项目相关的配置说明，都存在注释  
    c3p0-config.xml 内是定义数据库的配置。  
    custom-data.properties 内定义着常用的测试数据  
    type-convert.properties  内定义着第三方接口工具的类型转换  
    freemarker\content.ftl 内定义着复杂的结构组装，可自定义扩展。  

7.  自定义包装类型解析器  
    只需要在 applicationConfig.getTargetProjectConfig().setExclusiveFieldMap(new Hash()); 定义好相关不想生成的字段就可以了。
    key是类的全限定名
    value是字段名 
    
    目前是基于先解析doc生成相应的Structure然后转化成相应的Data，因此自定义类型转换器涉及到2个地方。自定义开发的话，请参考上面 `typeResolverChain` 和 `docAnalysisChain` 样例。
    
8.  结束语  
    闲着无聊写的，希望能方便到大家~，~！