Swagger项目是一个可以将Restful服务的接口api doc可视化的工具，而且提供了在线调试api的功能，对于开发的Restful服务非常友好，因此可以将其集成到项目中来。
这里通过spring initializer创建一个结构简单的spring boot程序，来展示Swagger的使用, 完整的项目示例参见：
创建一个
spring boot web应用，导入web，jpa,h2，test等模块。引入
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>
- 以一个
Person模型的查询(query)为例，创建POJO类Person、数据访问ContactDao接口、服务ContactService接口、以及对应的Restful服务控制器Controller。其中，在Controller中暴露3个Rest服务接口：
@RestController
@RequestMapping("/")
public class ContactController {
@Autowired
private ContactService contactService;
@GetMapping("/test")
public String test() {
return "hello world";
}
@GetMapping("/persons")
public Iterable<Person> getAllPersons() {
return contactService.getAllContacts();
}
@GetMapping("/getPersonById")
public Person getPersonById(@RequestParam("id") int personId) {
return contactService.getContactById(personId);
}
-
/test用来测试 -
/persons查询所有Person对象 -
getPersonById根据id来查询对应的Person
- 配置
Swagger
使用注解@EnableSwagger2来启用相关功能。
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("io.github.ted005.swaggerdemo.controller"))
.build();
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
- 运行查看
api doc, 打开http://localhost:8080/swagger-ui.html，会列出提供的api接口。
Screenshot_2019-01-21 Swagger UI.png
而且，还可以对每一个接口进行测试（可能需要构造请求参数）：
Screenshot_2019-01-21 Swagger UI(1).png
