spring boot api文档,
目录
春狐是什么,有什么用?Springfox的依赖Springfox的配置测试的控制
Springfox是什么,有什么用?
春狐基于斯瓦格,能更方便的集成到板簧罩中,招摇过市是一个规范和完整的框架,用于生成、描述、调用和可视化安静的风格的网服务大摇大摆。的目标是对应用程序接口定义一个标准的和语言无关的接口,可让人和计算机无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过时髦的进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,招摇过市消除了调用服务时可能会有的猜测。
Springfox官方文档:http://春狐。github。io/spring fox/docs/快照/
Springfox的依赖
dependencygroupidio。spring fox/groupid artifactid spring fox-swagger 2/artifactid version 2。4 .0/version/dependencycgroupidio。spring fox/groupid artifactid spring fox-swagger-ui/artifactid version 2。4 .0/版本/依赖项
Springfox的配置
@ Configuration @ enable swagger 2 public class swagger config { @ Bean public Docket demo API(){ return new Docket(documentation type .SWAGGER_2).groupName(“演示”).genericmodelestoptions(延迟结果。类).useDefaultResponseMessages(false).forCodeGeneration(false) //.路径映射(/) //根路径.选择()。路径(路径选择器。regex(/user/).*))//筛选展示的接口,使用PathSelectors.any(),展示所有接口.构建()。API info(demoapinfo());} //api信息私有API信息demoApiInfo(){ API信息API信息=新API信息(自己平台的api ,//大标题时髦的搭建美国石油学会(美国石油协会)平台,//小标题1.0,//版本没有服务条款, 632104866@qq.com ,//作者这是我的技术博客站点,//链接显示文字http://www.kailing.pub//网站链接);返回apiInfo}}
测试的Controll
@ rest控制器@请求映射(/用户)公共类SwaggerDemoController { @ request mapping(value=/demo 2 ,method=RequestMethod .POST) @ApiOperation(value=测试接口1 ,注释=测试接口详细描述)@响应体模型图get demo(@请求体用户User){模型图map=新模型图();map.addAttribute(userId ,111);map.addAttribute(userName , kl博客);返回地图;} @响应正文@请求映射(value=/demo 3 ,method=RequestMethod .POST) @ApiOperation(value=测试接口2 ,注释=测试接口详细描述,code=200,produces= application/JSON )public model map get demoa(@ request param( name )String demo name,@ request param String content){ model map map=new model map();map.addAttribute(result ,演示名 AAA );返回地图;} @ResponseBody @ApiIgnore //使用这个注解忽略这个接口@RequestMapping(value=/demo4 ,method=RequestMethod .POST)公共模型映射get demob(@ request param String content){ model map map=new model map();map.addAttribute(result ,新Java。util。date());返回地图;}}在浏览器输入http://localhost :8080/swagger-ui。html,可查看是否整合成功
至此我们的额美国石油学会(美国石油协会)在线文档整合完成了,下面是效果图
以上就是板簧罩整合Springfox生成安静的的在线美国石油学会(美国石油协会)文档的详细内容,更多关于板簧罩整合Springfox生成安静的在线美国石油学会(美国石油协会)的资料请关注盛行信息技术其它相关文章!
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。