knife4j 常用注解
时间: 2023-08-31 08:11:08 浏览: 93
Knife4j常用的注解包括:
1. @Api:用于对Controller类添加API文档的说明和描述。可以在类级别使用,表示该类是一个API资源。
2. @ApiOperation:用于对Controller中的方法添加API操作的说明和描述。可以在方法级别使用,表示该方法是一个API操作。
3. @ApiParam:用于对Controller中方法的参数添加API参数的说明和描述。可以在方法参数级别使用,表示该参数是一个API参数。
4. @ApiImplicitParam:和@ApiParam类似,用于对Controller中的方法参数添加API参数的说明和描述。可以在方法参数级别使用,表示该参数是一个API参数。
5. @ApiModel:用于对实体类添加API模型的说明和描述。可以在类级别使用,表示该类是一个API模型。
6. @ApiModelProperty:用于对实体类的属性添加API属性的说明和描述。可以在属性级别使用,表示该属性是一个API属性。
例如,在使用Knife4j时,可以使用@Api注解来标注Controller类,使用@ApiOperation注解来标注Controller中的方法,使用@ApiParam注解来标注方法参数,使用@ApiModel注解来标注实体类,使用@ApiModelProperty注解来标注实体类的属性。这样可以为API文档添加详细的说明和描述,提高接口文档的可读性和可理解性。<span class="em">1</span><span class="em">2</span>
#### 引用[.reference_title]
- *1* [Knife4j注解说明](https://blog.csdn.net/qq_46126559/article/details/118487809)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"]
- *2* [swagger2(knife4j) 注解说明](https://blog.csdn.net/leaf__yang/article/details/126279902)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"]
[ .reference_list ]