# Swagger-Leraning

**Repository Path**: yangguiseng/swagger

## Basic Information

- **Project Name**: Swagger-Leraning
- **Description**: swagger学习
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 5
- **Created**: 2021-09-16
- **Last Updated**: 2023-12-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码，了解更多内容，见参考资料。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单

### Swagger常用注解
1. @Api 标识Controller使用swagger.
2. @ApiImplicitParam 表示一个隐式的请求参数，即请求方法中没有显示绑定参数名称.
3. @ApiImplicitParams 表示隐式参数列表.
4. @ApiModel 描述请求或返回对象的额外信息.
5. @ApiModelProperty 描述或者生成ApiModel的成员变量.
6. @ApiOperation 描述一个Http请求方法
7. @ApiParam 描述显示的请求参数.
8. @ApiResponse 描述可能的返回对象.
9. @ApiResponses 表示返回对象列表.
10. @Authorization 申明认证信息.
11. @ResponseHeader 表示返回头部信息.

##### chapter3-1-5参考自:[程序猿DD博客](http://blog.didispace.com/)
- chapter3-1-5：[使用Swagger2构建RESTful API](http://blog.didispace.com/springbootswagger2/)

##### swagger-starter-demo 参考自:
- https://github.com/dyc87112/swagger-starter-demo