# auto-api

**Repository Path**: build/auto-api

## Basic Information

- **Project Name**: auto-api
- **Description**: 一、背景
通常的文档生成工具，都需要开发人员编写注解或注释，代码入侵太强，而且费事，我希望api工具具有如下功能：

1.自动解析代码，根据代码生成api接口，如果有注释就自动扫描注释(自动集成swagger)，没有就以代码为准，生成的api接口如果有不合理的地方，可以在页面进行修改，利用web页面的表单编辑修改要比在代码里处理方便直观。
2.Api接口调整自动完成维护，自动通知开发测试改动部分内容（集成邮件或极光推送等）。
3.自动按项目模块结构归(移植对接yapi项目目录结构)，可自由调整目录结构。
4.开发测试api自动集成登录验证，直接输入参数请求调试接口，支持默认数据字典数据填充，前后台都抛弃PostMan等第三方测试工具。
5.Api接口确定后前后端开发分离，自动mock接口数据，开发完成关闭mock进入联调。
6.工具提供自动化测试，根据测试场景自由按接口api组合，设置测试案例集合。生成测试案例报告。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-02-09
- **Last Updated**: 2023-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# auto-api

#### Description
一、背景
通常的文档生成工具，都需要开发人员编写注解或注释，代码入侵太强，而且费事，我希望api工具具有如下功能：

1.自动解析代码，根据代码生成api接口，如果有注释就自动扫描注释(自动集成swagger)，没有就以代码为准，生成的api接口如果有不合理的地方，可以在页面进行修改，利用web页面的表单编辑修改要比在代码里处理方便直观。
2.Api接口调整自动完成维护，自动通知开发测试改动部分内容（集成邮件或极光推送等）。
3.自动按项目模块结构归(移植对接yapi项目目录结构)，可自由调整目录结构。
4.开发测试api自动集成登录验证，直接输入参数请求调试接口，支持默认数据字典数据填充，前后台都抛弃PostMan等第三方测试工具。
5.Api接口确定后前后端开发分离，自动mock接口数据，开发完成关闭mock进入联调。
6.工具提供自动化测试，根据测试场景自由按接口api组合，设置测试案例集合。生成测试案例报告。

#### Software Architecture
Software architecture description

#### Installation

1.  xxxx
2.  xxxx
3.  xxxx

#### Instructions

1.  xxxx
2.  xxxx
3.  xxxx

#### Contribution

1.  Fork the repository
2.  Create Feat_xxx branch
3.  Commit your code
4.  Create Pull Request


#### Gitee Feature

1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
4.  The most valuable open source project [GVP](https://gitee.com/gvp)
5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)