# SPeed-Doc 零代码即可生成支持 ApiFox 接口文档工具

**Repository Path**: tlgen_1/speed-doc

## Basic Information

- **Project Name**: SPeed-Doc 零代码即可生成支持 ApiFox 接口文档工具
- **Description**: 1.无需配置繁杂注解, 零代码   
2.只需要你正常写注释, 不需要写太多, 就正常接口类和接口方法, 实体类字段注释即可  
3.支持兼容 ApiFox 工具, 生成的文档可以进行导入  
4.支持简便配置选择生成的文件类型, HTML、JSON、DOC、PDF  
5.引入依赖自动生成  
6.也支持手动调用 API 生成  
7.支持模块化项目全部接口生成
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-29
- **Last Updated**: 2024-03-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SPeed-Doc 手写实现生成接口文档

#### 框架简介

```ruby
1.无需配置繁杂注解, 零代码   
2.只需要你正常写注释, 不需要写太多, 就正常接口类和接口方法, 实体类字段注释即可  
3.支持兼容 ApiFox 工具, 生成的文档可以进行导入  
4.支持简便配置选择生成的文件类型, HTML、JSON、DOC、PDF  
5.引入依赖自动生成  
6.也支持手动调用 API 生成  
7.支持模块化项目全部接口生成  
```

#### 快速上手

可以直接下载代码根目录下的 [speed-spring-0.0.1.jar](speed-spring-0.0.1.jar) 引入, 或本地 install 引入如下(未打入 Maven 中央仓库)

```ruby
        <dependency>
            <groupId>com.tlgen</groupId>
            <artifactId>speed-doc</artifactId>
            <version>0.0.1</version>
        </dependency>
```

#### 支持手动调用方法生成

```ruby
 SpeedDoc.generateApiFox();
```