SpringBoot整合Swagger测试api构建

1、springboot整合swagger测试api构建什么是swagger？ swagger是什么：the world’s most popular api tooling 按照官网的介绍： swagger inspector：测试api和生成openapi的开发工具。swagger inspector的建立是为了解决开发者的三个主要目标。 执行容易的api测试 生成openapi文档 探究新的api功能 假如想学习java工程化、高性能及分布式、深化浅出。微服务、spring，mybatis，netty源码分析的伴侣可以加我的java高级沟通：854630135，群里有阿里

2、大牛直播讲解技术，以及java大型互联网技术的视频免费共享给大家。 我的理解swagger是一个规范和完整的框架，用于生成、描述、调用和可视化restful风格的web服务。容易来说，swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分别解决计划。按照我的用法，固然我只是最容易的用法，我感觉swagger有以下几个优点： swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成api文档。 将前端后台分开，不会有过分的依靠。 界面清楚，无论是editor的实时展示还是ui的展示都非常人性化，假如自己仅仅用markdown来编写，又要纠结该如何呈现，非常疼痛。

3、 构建项目 step1.导入依靠 io.springfox springfox-swagger2 2.6.1 io.springfox springfox-swagger-ui 2.6.1 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test step2.编写swagger配置类 想要用法swagger功能必需提供配置类，主要配置ui界面信息，以及配置扫描位置，swagger会按照配置的路径扫描全部的服务生成api。 其中核心requesth

4、andlerselectors.basepackage("com.simple.spring.boot.controller"),在这里配置我们的需要的扫描包位置。 假如想学习java工程化、高性能及分布式、深化浅出。微服务、spring，mybatis，netty源码分析的伴侣可以加我的java高级沟通：854630135，群里有阿里大牛直播讲解技术，以及java大型互联网技术的视频免费共享给大家。 configuration enableswagger2 public class swaggerconfig bean public docket crea

5、terestapi() return new docket(documentationtype.swagger_2).apiinfo(apiinfo() .select() .apis(requesthandlerselectors.basepackage("com.simple.spring.boot.controller") .paths(pathselectors.any().build(); private apiinfo apiinfo() return new apiinfobuilder() .title("spring bo

6、ot中用法swagger2构建restful apis") .description("myapp") .termsofserviceurl(" .version("1.0").build(); step3.编写springboot启动类 componentscan(basepackages="com.simple.spring.boot.controller") 也是需要配置扫描路径。 springbootapplication components

7、can(basepackages="com.simple.spring.boot.controller") public class swaggerapplication public static void main(string args) springapplication.run(swaggerapplication.class, args); step4.创建前端控制器 restcontroller api(tags = "swgger测试服务", description = "swgger测试

8、服务") requestmapping(value = "/simple/wu") public class testcontroller apioperation(value="测试post办法", notes="测试post办法") apiimplicitparam(name = "令牌", value = "id", required = true, datatype = "

9、token") requestmapping(value="hello", method=requestmethod.post) public string post(requestbody string token) books.put(book.getid(), book); return "success" api(tags = "swgger测试服务", description = "swgger测试服务") 指定某个类提供服

10、务的名字 apioperation(value="测试post办法", notes="测试post办法") 指定某个哀求的名字 apiimplicitparam(name = "令牌", value = "token", required = true, datatype = "string")指定名字对应参数为令牌，以及对应参数字段token，required = true代表这个参数为必填参数，datatype

11、代表数据类型。 step5.启动服务 从上面的代码中我们指定哀求为post在ui界面上我们会看到一个服务名字为swgger测试服务的大类点击进去后可以看到里面所拥有的哀求，假如指定这个哀求的类型那么无法举行单元测试，指定后我们会看到一个哀求名字叫做测试post办法的哀求并且需要填入必填参数token来完成我们的单元测试。 我们可以挺直通过swaggerapplication类来运行main办法来举行服务，端口号默认为8080. swagger地址：http:/localhost:8080/swagger-ui.html 只需要在地址后面加上swagger-ui.html即可拜访 我们拜访这个位置即可看到ui界面，界面简洁并且简单上手