doc: 增加swagger2- openApi2注解变化

matevip · matevip · commit b4ddacdd1eef · 2022-11-27T08:39:35.000+08:00
diff --git a/README.md b/README.md
@@ -198,6 +198,17 @@ matecloud -- &#29238;&#39033;&#30446;,&#21508;&#27169;&#22359;&#20998;&#31163;&#65292;&#26041;&#20415;&#38598;&#25104;&#21644;&#24494;&#26381;&#21153;
 
 - &#129381; [https://gitee.com/matevip/mate-demo](https://gitee.com/matevip/mate-demo)
 
+## &#127789; Swagger2 - OpenAPI3
+|  Swagger2      |  OpenAPI3  | &#27880;&#35299;&#20301;&#32622;                         |
+|  ----  | ----  |------------------------------|
+| `@Api`  | @Tag(name = "&#25509;&#21475;&#31867;&#25551;&#36848;") | Controller &#31867;&#19978;                |
+| `@ApiOperation`  | @Operation(summary ="&#25509;&#21475;&#26041;&#27861;&#25551;&#36848;") | Controller &#26041;&#27861;&#19978;               |
+| `@ApiImplicitParam`  | @Parameter(description="&#21442;&#25968;&#25551;&#36848;") | Controller &#26041;&#27861;&#19978; @Parameters &#37324; |
+| `@ApiImplicitParams`  | @Parameters | Controller &#26041;&#27861;&#19978;               |
+| `@ApiParam`  | @Parameter(description="&#21442;&#25968;&#25551;&#36848;") | Controller &#26041;&#27861;&#30340;&#21442;&#25968;&#19978;            |
+| `@ApiIgnore`  | @Parameter(hidden = true) &#25110; @Operation(hidden = true) &#25110; @Hidden | ----                         |
+| `@ApiModel`  | @Schema	 | Entity&#31867;&#19978;                     |
+| `@ApiModelProperty`  | @Schema	 | Entity&#23646;&#24615;&#19978;                    |
 ## &#127867; &#36129;&#29486;&#32773;&#21517;&#21333;
 &#27426;&#36814;&#25552;&#20132;[PR](https://gitee.com/matevip/matecloud/pulls)&#19968;&#36215;&#23436;&#21892;&#39033;&#30446;&#65292;&#20197;&#19979;&#20026;&#24320;&#28304;&#39033;&#30446;&#36129;&#29486;&#30340;&#25112;&#21451;&#65288;&#25490;&#21517;&#19981;&#20998;&#20808;&#21518;&#65289;&#65306;
 

-Original file line number
+Diff line change
 - 🥥 [https://gitee.com/matevip/mate-demo](https://gitee.com/matevip/mate-demo)
 +## 🌭 Swagger2 - OpenAPI3
 +|  Swagger2      |  OpenAPI3  | 注解位置                         |
 +|  ----  | ----  |------------------------------|
 +| `@Api`  | @Tag(name = "接口类描述") | Controller 类上                |
 +| `@ApiOperation`  | @Operation(summary ="接口方法描述") | Controller 方法上               |
 +| `@ApiImplicitParam`  | @Parameter(description="参数描述") | Controller 方法上 @Parameters 里 |
 +| `@ApiImplicitParams`  | @Parameters | Controller 方法上               |
 +| `@ApiParam`  | @Parameter(description="参数描述") | Controller 方法的参数上            |
 +| `@ApiIgnore`  | @Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden | ----                         |
 +| `@ApiModel`  | @Schema	 | Entity类上                     |
 +| `@ApiModelProperty`  | @Schema	 | Entity属性上                    |
 ## 🍻 贡献者名单
 欢迎提交[PR](https://gitee.com/matevip/matecloud/pulls)一起完善项目，以下为开源项目贡献的战友（排名不分先后）：