Swagger
Swagger是一種和語言無關的規范和框架，用于定義服務接口，主要用于描述RESTful的API。它專注于為API創建優秀的文檔和客戶端庫。支持Swagger的API可以為API方法生成交互式的文檔，讓用戶可以通過以可視化的方式試驗，查看請求和響應、頭文件和返回代碼，從而發現API的功能。
swagger用于定義API文檔。
好處：
- 前后端分離開發
- API文檔非常明確
- 測試的時候不需要再使用URL輸入瀏覽器的方式來訪問Controller
- 傳統的輸入URL的測試方式對于post請求的傳參比較麻煩（當然，可以使用postman這樣的瀏覽器插件）
- spring-boot與swagger的集比較成簡單
步驟
1.jar包引入
|
1
2
3
4
5
6
7
8
9
10
11
12
|
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> <scope>compile</scope></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> <scope>compile</scope></dependency> |
2.基于SpringBoot配置SwaggerConfig
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket newsApi() { //return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.any()).build(); Docket docket = new Docket(DocumentationType.SWAGGER_2); docket.enable(true); docket.apiInfo(apiInfo()).select().paths(PathSelectors.any()).build(); return docket; } private ApiInfo apiInfo() { return new ApiInfoBuilder().title("訂單中心測試平臺").description("在這里你可以瀏覽項目所有接口，并提供相關測試工具") .termsOfServiceUrl("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?Open").contact("test") .license("China Red Star Licence Version 1.0").licenseUrl("#").version("1.0").build(); }} |
3.WebConfig配置說明
這里有一個需要注意的問題，讓WebConfig去繼承WebMvcAutoConfigurationAdapter而不是直接繼承WebMvcConfigurerAdapter，否則Swagger的頁面出不來。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
@Configuration@EnableWebMvcpublic class WebConfig extends WebMvcAutoConfigurationAdapter { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/**"); } @Bean public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() { return new PropertySourcesPlaceholderConfigurer(); } @Bean public Filter characterEncodingFilter() { CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter(); characterEncodingFilter.setEncoding("UTF-8"); characterEncodingFilter.setForceEncoding(true); return characterEncodingFilter; } @Bean public MappingJackson2HttpMessageConverter converter() { MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter(); return converter; } @Bean public ViewResolver getViewResolver() { InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setViewClass(JstlView.class); resolver.setPrefix("/jsp"); resolver.setSuffix(".jsp"); return resolver; } @Bean public StandardServletMultipartResolver getStandardServletMultipartResolver() { return new StandardServletMultipartResolver(); }} |
4.SwaggerUI頁面訪問
http://localhost:8080/projectName/swagger-ui.html#!/
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://segmentfault.com/a/1190000008498102
