swagger 实体类注解（swaggerui注解）

R语言数据分析来源：网络编辑：小编更新时间：2026-04-23 18:09:04 浏览量：3

1、Swagger的介绍

　　1、系统启动，扫描到api工程中的Swagger2Configuration类

　　2、在此类中指定了包路径，会找到在此包下及子包下标记有@RestController注解的controller类

　　3、根据controller类中的Swagger注解生成接口文档。

　　@Api：修饰整个类，描述Controller的作用

　　@ApiOperation：描述一个类的一个方法，或者说一个接口

　　@ApiParam：单个参数描述

　　@ApiModel：用对象来接收参数

　　@ApiModelProperty：用对象接收参数时，描述对象的一个字段

　　@ApiResponse：HTTP响应其中1个描述

　　@ApiResponses：HTTP响应整体描述

　　@ApiIgnore：使用该注解忽略这个API

　　@ApiError ：发生错误返回的信息

　　@ApiImplicitParam：一个请求参数，这个请求参数可以为空

　　@ApiImplicitParams：多个请求参数

2、SpringBoot项目下如何生成Swagger接口文档

 1 
  
    
    
     
     
    2 
   
     
     
       io.springfox 
      3 
   
     
     
       springfox-swagger2 
      4 
   
     
     
       2.7.0 
      5 
  
    
     6 
  
    
    
     
     
    7 
   
     
     
       io.springfox 
      8 
   
     
     
       springfox-swagger-ui 
      9 
   
     
     
       2.7.0 
      10

 1 @Configuration 2 @EnableSwagger2 3 public class Swagger2Configuration { 4 5 @Bean 6 public Docket createRestApi() { 7 return new Docket(DocumentationType.SWAGGER_2) 8 .apiInfo(apiInfo()) 9 .select() 10 .apis(RequestHandlerSelectors.basePackage("......")) 11 .paths(PathSelectors.any()) 12 .build(); 13 } 14 15 private ApiInfo apiInfo() { 16 return new ApiInfoBuilder() 17 .title("XXX") 18 .description("XXXXXX") 19 // .termsOfServiceUrl("/") 20 .version("1.0") 21 .build(); 22 } 23 }

 1 @Api(value="测试Controller",tags={"用户操作接口"}) 2 @RestController 3 public class TestController { 4 5 @PostMapping("/test") 6 @ApiOperation(value="此接口用于测试Swagger") 7 @ApiImplicitParams( 8 { 9 @ApiImplicitParam(name="page",value = "页码",required=true,paramType="path",dataType="int") 10 ,@ApiImplicitParam(name="size",value = "每页记录数",required=true,paramType="path",dataType="int") 11 }) 12 public ResponseData

@Data public class ItemListReq { //页码 从0开始 @ApiModelProperty("页码 从0开始") int pageNo =0 ; //单页返回的记录数 @ApiModelProperty("单页返回的记录数,默认值10") int pageSize = 10 ; //标准商品编号 @ApiModelProperty("标准商品编号") String itemId; //标准商品名称,支持不带特殊字符的模糊匹配 @ApiModelProperty("标准商品名称,支持不带特殊字符的模糊匹配") String itemName; }

Swagger详解_spring

到此这篇swagger 实体类注解（swaggerui注解）的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章，希望大家都能在编程的领域有一番成就！

上一篇：苹果promax价格256官网价格（iphone pro max 256 官方价格）

下一篇： aurochs（aurochs是什么意思）

版权声明：
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/47637.html

相关文章：