1. 首页首页
  2. 科技前沿科技前沿

swaggerui注解（swagger 实体类注解）

科技前沿 • • 阅读 45

swaggerui注解（swagger 实体类注解）添加依赖 lt dependency gt lt groupId gt io springfox lt groupId gt lt artifactId gt springfox swagger2 lt artifactId gt lt version gt 2 9 2 amp

大家好，我是讯享网，很高兴认识大家。



添加依赖:

<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger2</artifactId>
 <version>2.9.2</version>
</dependency>
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger-ui</artifactId>
 <version>2.9.2</version>
</dependency>

讯享网

1.swagger配置:

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

讯享网@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

通过Appinfo配置

swagger入门_前后端分离
讯享网

 

 其中contact是作者信息

2.swagger生产环境中关闭、过滤及扫描指定包

关闭 通过Docker.enable关闭

过滤通过.path(路径)过滤

自定义扫描

swagger入门_前后端分离_02

 

 3.分组

通过.gruopName()分组

示例

swagger入门_实体类_03

 

 效果

swagger入门_参数说明_04

 

 4.swagger-ui操作即注解

swagger操作

测试controller

swagger入门_参数说明_05

 

 点击try it out

swagger入门_实体类_06

 

 code表示状态

常用注解

Swagger注解 简单说明 @Api(tags = “xxx模块说明”) 作用在模块类上 @ApiOperation(“xxx接口说明”) 作用在接口方法上 @ApiModel(“xxxPOJO说明”) 作用在模型类上：如VO、BO @ApiModelProperty(value = “xxx属性说明”,hidden = true) 作用在类方法和属性上，hidden设置为true可以隐藏该属性 @ApiParam(“xxx参数说明”) 作用在参数、方法和字段上，类似@ApiModelProperty

@ApiModel 和 @ApiModelPropertery

添加在实体类的和实体类属性添加说明

ps:swagger是前后端分离技术

 


                    


                    


                    

                        

                            

                                小讯
                            

                            

                                

                                    
                                        
                                    
                                

                            

                        

                    

                


                

                    
                    
                    

                        
                        

                             上一篇
                            2025-06-15 07:34
                        

                    

                    
                    


                    
                    
                    

                        
                        

                            下一篇 
                            2025-04-19 11:16
                        

                    

                    
                    
                


                

                    
相关推荐

                    
                

                

                    

                        版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/143242.html