# catch-admin-swagger

**Repository Path**: h_mo/catch-admin-swagger

## Basic Information

- **Project Name**: catch-admin-swagger
- **Description**: catch-admin后端,配合前端catch-admin-react
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-29
- **Last Updated**: 2021-08-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### catch-admin-swagger

配合前端[catch-admin-react](https://gitee.com/hcgmomo/catch-admin-react) ,提供便捷的API,在  [CatchAdmin](https://gitee.com/jaguarjack/catchAdmin) 的基础上进行了一些修改,主要是添加了swagger

#### API 文档

为了不对原本CatchAdmin代码产生影响,在每个模块下面都有一个swagger目录或文件,用来单独编写swagger

另外还单独加了swagger模块,用来编写一些公共的Schema

采用最新版Swagger3（Open Api3）生成api文档

配合 [swagger-ui](https://petstore.swagger.io/) 即可查看api文档,效果如下:

![](https://img-blog.csdnimg.cn/20210507215105153.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NzU3MTc0,size_16,color_FFFFFF,t_70#pic_center)

生成静态openapi.json:

```bash
./vendor/bin/openapi --output openapi.json ./catch
```

#### 前端使用

添加swagger主要是为了让前端自动生成serves  api接口,typescript类型和mock 数据,使用方法请看[文档](https://beta-pro.ant.design/docs/openapi-cn)

#### 其他

- 修改了统一的响应参数
- 修改了数据库users表avatar字段的类型