swagger可视化开发文档注解小结

注解小总结，新手可以拿起小笔笔记下来咯

---

前言

小小的说一下swagger是什么东西

• Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
• Swagger 工具由原始“Swagger”规范背后的团队开发。Swagger 提供了最强大和最容易使用的工具来充分利用 OpenAPI
  规范。

---

一、swagger注解

在java类中添加swagger的注解即可生成swagger接口文档，常用的swagger注解有

1. @Api：修饰整个类，描述Controller的作用
2. @ApiOperation：描述一个类的方法，或者可以说是一个接口
3. @ApiParam：单个阐述的描述信息
4. @ApiModel：用对象来接收参数
5. @ApiModelProperty：用对象接收参数时，描述对象的一个字段
6. @ApiResponse：HTTP响应其中1个描述
7. @ApiResponses：HTTP响应整体描述
8. @ApiLgnore：使用该注解忽略这个API
9. @ApiError：发生错误返回的信息
10. @ApiImplicitParam：一个请求参数
11. @ApiLmplicitParams：对个请求参数的描述信息
12. @AuthorizationScope：OAuth2的授权范围

• 自然还有其他注解参数（就举一些写swagger会经常用的到参数就行啦）

二、ApilmplicitParam属性

属性	取值	作用
ParamType		参训参数类型
ParamType	path	以地址形式提交数据
ParamType	query	直接与参数完成映射并自动赋值
ParamType	body	以流的形式提交 仅支持POST
ParamType	hander	参数在request hander里头进行提交
ParamType	form	以表单的形式提交 仅支持POST
dataType		参数的数据类型 只作为标志说明，并没有实际的验证
dataType	Long
dataType	String
name	String
value	String	接收参数名
required	String	参数是否必填
-	true	必填
-	false	非必填
defaultValue		默认值

更多链接

官网

• 链接: https://swagger.io/

开源文档

• 链接: https://github.com/swagger-api/

Swagger 编辑器文档

• 链接: https://github.com/swagger-api/swagger-editor

SwaggerHub文档

• 链接: https://support.smartbear.com/swaggerhub/docs/about.html

---

总结

• 一些之前自学的笔记，分享出来，不是详解全面版！！！