SpringBoot Swagger框架
- 2020 年 1 月 1 日
- 筆記
本文標識 : Jsbt0004
本文編輯 : Jack 風
編程工具 : IDEA
閱讀時長 : 6分鐘
::: tip Swagger
描述和測試 API 接口,自動生成 API 接口文檔。
:::
為了方便上面的 API 接口調試，我們可以使用：
- Postman：模擬 POST 請求
- Swagger：描述和測試 API 接口
1、添加依賴
<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>
2、Swagger 配置
yml 配置文件
swagger: title: SpringBoot學習 description: SpringBoot快速入門 version: 1.0.0 name: JackFeng url: http://a2data.cn email: [email protected]
Swagger 配置文件
/** * @author: jack[QQ:66860619] * @create: 2019-11-20 * @description: */ @ConfigurationProperties(prefix = "swagger") @Configuration //必須存在 @EnableSwagger2 //必須存在 @EnableWebMvc //必須存在 @Data //lomlok //必須存在 掃描的API Controller包 @ComponentScan(basePackages = {"com.jack.demo.controller"}) public class SwaggerConfig{ private String title; private String description; private String version; private String name; private String url; private String email; @Bean public Docket customDocket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()); } private ApiInfo apiInfo() { Contact contact = new Contact(name, url, email); return new ApiInfoBuilder() .title(title) .description(description) .contact(contact) .version(version) .build(); } }
配置文件中的值到配置類中的注入，在第八章 springboot-08-配置文件的注入中有介紹
MVC 配置
作用：過濾網頁靜態資源
@Configuration class WebMvcConfig implements WebMvcConfigurer { public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } }
3、使用註解
在控制器 API 上添加接口描述的註解
@RestController @Api(value = "用戶模塊") public class HelloController { @GetMapping("/hello") @ApiOperation(value = "測試Swagger") public String hello(){ return "hello SpringBoot-swagger"; } }
4、Webjars 的使用
官網：https://www.webjars.org/
<dependency> <groupId>org.webjars</groupId> <artifactId>jquery</artifactId> <version>3.3.1-1</version> </dependency>
通過 jar 包的方式引入了 jQuery
再瀏覽器中可以通過如下地址訪問到
http://localhost:8080/webjars/jquery/3.3.1-1/jquery.js
地址說明：/webjars/jquery/3.3.1-1/jquery.js
對應上面的 webjars/ artifactId/version/文件名
可以到項目中的 jar 包中具體查看。
