# swagger-spring

**Repository Path**: tanpenggood/swagger-spring

## Basic Information

- **Project Name**: swagger-spring
- **Description**: swagger-spring
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-11-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Swagger generated server

Spring Boot Server 

## 背景

前后端的同学们一直在强调：开发应用之前一定要前后端在一起先约定接口文档。

奈何每一次大家碰到一起时都无从下手，最后又回到了各自的工位闷头撸代码。

**常见场景如下：**
1. （地狱模式）直接没有接口文档 
    ```
    后端开发结束 -> 前端调后端接口 -> 前端询问后端接口返回的数据代表的含义、前端询问后端接口入参的含义 -> 前端将数据转换成后端接口的入参数据结构、前端将后端接口的返回数据转换成自己需要的数据结构 -> 接口对接成功
    ```
2. （高档模式）后端开发结束时为前端生成了接口文档 
    ```
    后端开发结束 -> 后端生成接口文档 -> 前端根据接口文档的调用API -> 接口对接成功
    ```
3. （天堂模式）开发之前，前后端一起根据业务需求约定了接口文档
    ```
    后端根据接口文档开发接口 -> 前端根据接口文档调用接口 -> 接口对接成功
    
    从此以后，前后端同学再也没有撕扯，世界一片祥和...
    ```
    
那么问题来了，怎么引领团队的同学进入到`天堂模式`?

请访问：http://editor.swagger.io/

## editor.swagger使用步骤

> 以使用`editor.swagger`生成spring项目为例

1. 访问http://editor.swagger.io/
2. 在左侧编辑器中书写接口文档(也可线下使用编辑器书写，线上导入)
3. 点击`Generate Server`，选择`spring`
4. 解压`zip`包
5. 启动项目完毕后，查看接口文档访问：http://localhost:8080/v2/swagger-ui.html

## 功能特点

- 三种扫描方式
    - 单包扫描
    - 多包扫描
    - 指定注解扫描
- 两种接口界面
    - swagger2 `http://localhost:8080/v2/swagger-ui.html`
    - swagger-bootstrap-ui `http://localhost:8080/v2/doc.html`

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request