电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁技術文章
文章詳情頁

SpringBoot整合Swagger2的示例

瀏覽:4日期:2023-04-10 18:53:33

一、導入maven包 

<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>

二、添加工具類

@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2).pathMapping('/').select().apis(RequestHandlerSelectors.basePackage('com.nvn.controller')).paths(PathSelectors.any()).build().apiInfo(new ApiInfoBuilder() .title('SpringBoot整合Swagger') .description('SpringBoot整合Swagger,詳細信息......') .version('1.0') .build()); }}

三、添加注解

@RestController@Api(tags = '用戶管理相關接口')@RequestMapping('/user')public class UserController { @PostMapping('/') @ApiOperation('添加用戶的接口') @ApiImplicitParams({ @ApiImplicitParam(name = 'username', value = '用戶名', defaultValue = '李四'), @ApiImplicitParam(name = 'address', value = '用戶地址', defaultValue = '深圳', required = true) } ) public RespBean addUser(String username, @RequestParam(required = true) String address) { return new RespBean(); } @GetMapping('/') @ApiOperation('根據id查詢用戶的接口') @ApiImplicitParam(name = 'id', value = '用戶id', defaultValue = '99', required = true) public User getUserById(@PathVariable Integer id) { User user = new User(); user.setId(id); return user; } @PutMapping('/{id}') @ApiOperation('根據id更新用戶的接口') public User updateUserById(@RequestBody User user) { return user; }}

四、注解說明

@Api注解可以用來標記當前Controller的功能。 @ApiOperation注解用來標記一個方法的作用。 @ApiImplicitParam注解用來描述一個參數,可以配置參數的中文含義,也可以給參數設置默認值,這樣在接口測試的時候可以避免手動輸入。 如果有多個參數,則需要使用多個@ApiImplicitParam注解來描述,多個@ApiImplicitParam注解需要放在一個@ApiImplicitParams注解中。 @ApiImplicitParam注解中雖然可以指定參數是必填的,但是卻不能代替@RequestParam(required = true),前者的必填只是在Swagger2框架內必填,拋棄了Swagger2,這個限制就沒用了,所以假如開發者需要指定一個參數必填,@RequestParam(required = true)注解還是不能省略。

五、如果參數是一個對象,對于參數的描述可以放在實體類中。

@ApiModelpublic class User { @ApiModelProperty(value = '用戶id') private Integer id; @ApiModelProperty(value = '用戶名') private String username; @ApiModelProperty(value = '用戶地址') private String address; //getter/setter}

六、效果

SpringBoot整合Swagger2的示例

附:如果我們的Spring Boot項目中集成了Spring Security,那么如果不做額外配置,Swagger2文檔可能會被攔截,此時只需要在Spring Security的配置類中重寫configure方法,添加如下過濾即可:

@Overridepublic void configure(WebSecurity web) throws Exception { web.ignoring() .antMatchers('/swagger-ui.html') .antMatchers('/v2/**') .antMatchers('/swagger-resources/**');}

以上就是SpringBoot整合Swagger2的示例的詳細內容,更多關于SpringBoot整合Swagger2的資料請關注好吧啦網其它相關文章!

標簽: Spring
相關文章:
主站蜘蛛池模板: 航空连接器,航空插头,航空插座,航空接插件,航插_深圳鸿万科 | 超高频感应加热设备_高频感应电源厂家_CCD视觉检测设备_振动盘视觉检测设备_深圳雨滴科技-深圳市雨滴科技有限公司 | 扫地车厂家-山西洗地机-太原电动扫地车「大同朔州吕梁晋中忻州长治晋城洗地机」山西锦力环保科技有限公司 | 鑫达滑石-辽宁鑫达滑石集团 | 塑料检查井_双扣聚氯乙烯增强管_双壁波纹管-河南中盈塑料制品有限公司 | 精密机械零件加工_CNC加工_精密加工_数控车床加工_精密机械加工_机械零部件加工厂 | 线材成型机,线材折弯机,线材成型机厂家,贝朗自动化设备有限公司1 | 注塑模具_塑料模具_塑胶模具_范仕达【官网】_东莞模具设计与制造加工厂家 | 合肥网带炉_安徽箱式炉_钟罩炉-合肥品炙装备科技有限公司 | 西安烟道厂家_排气道厂家_包立管厂家「陕西西安」推荐西安天宇烟道 | 棕刚玉-白刚玉厂家价格_巩义市东翔净水材料厂| 数显水浴恒温振荡器-分液漏斗萃取振荡器-常州市凯航仪器有限公司 | 阜阳在线-阜阳综合门户| 水冷式工业冷水机组_风冷式工业冷水机_水冷螺杆冷冻机组-深圳市普威机械设备有限公司 | 日本SMC气缸接头-速度控制阀-日本三菱伺服电机-苏州禾力自动化科技有限公司 | 环氧铁红防锈漆_环氧漆_无溶剂环氧涂料_环氧防腐漆-华川涂料 | 深圳品牌设计公司-LOGO设计公司-VI设计公司-未壳创意 | 造价工程师网,考试时间查询,报名入口信息-网站首页 | 箱式破碎机_移动方箱式破碎机/价格/厂家_【华盛铭重工】 | 步入式高低温测试箱|海向仪器 | 铸铝门厂家,别墅大门庭院大门,别墅铸铝门铜门[十大品牌厂家]军强门业 | 真空粉体取样阀,电动楔式闸阀,电动针型阀-耐苛尔(上海)自动化仪表有限公司 | 汽液过滤网厂家_安平县银锐丝网有限公司 | 体感VRAR全息沉浸式3D投影多媒体展厅展会游戏互动-万展互动 | 东莞办公家具厂家直销-美鑫【免费3D效果图】全国办公桌/会议桌定制 | 镀锌钢格栅_热镀锌格栅板_钢格栅板_热镀锌钢格板-安平县昊泽丝网制品有限公司 | 药品/药物稳定性试验考察箱-埃里森仪器设备(上海)有限公司 | 液压压力机,液压折弯机,液压剪板机,模锻液压机-鲁南新力机床有限公司 | 心得体会网_心得体会格式范文模板 | 锌合金压铸-铝合金压铸厂-压铸模具-冷挤压-誉格精密压铸 | 济南玻璃安装_济南玻璃门_济南感应门_济南玻璃隔断_济南玻璃门维修_济南镜片安装_济南肯德基门_济南高隔间-济南凯轩鹏宇玻璃有限公司 | 刚性-柔性防水套管-橡胶伸缩接头-波纹管补偿器-启腾供水材料有限公司 | 伸缩节_伸缩器_传力接头_伸缩接头_巩义市联通管道厂 | 新型锤式破碎机_新型圆锥式_新型颚式破碎机_反击式打沙机_锤式制砂机_青州建源机械 | 菲希尔X射线测厚仪-菲希尔库伦法测厚仪-无锡骏展仪器有限责任公司 | 面粉仓_储酒罐_不锈钢储酒罐厂家-泰安鑫佳机械制造有限公司 | 安徽千住锡膏_安徽阿尔法锡膏锡条_安徽唯特偶锡膏_卡夫特胶水-芜湖荣亮电子科技有限公司 | 集装袋吨袋生产厂家-噸袋廠傢-塑料编织袋-纸塑复合袋-二手吨袋-太空袋-曹县建烨包装 | 青岛球场围网,青岛车间隔离网,青岛机器人围栏,青岛水源地围网,青岛围网,青岛隔离栅-青岛晟腾金属制品有限公司 | 盐城网络公司_盐城网站优化_盐城网站建设_盐城市启晨网络科技有限公司 | 珠海网站建设_响应网站建设_珠海建站公司_珠海网站设计与制作_珠海网讯互联 |