Swagger3的使用 2021-11-01 二橘

Swagger

前后端分离

• 后端：后端控制层，服务层，数据访问层
• 前端：前端控制层，视图层
  • 伪造后端数据，json。已经存在了
• 前后端如何交互==》API
• 前后端相对独立，松耦合
• 前后端可以部署在不同的服务器上

缺点：

• 前后端集成联调，前后端无法及时协商，尽早解决

解决方案：

• 制定计划，实时更新API，降低集成风险
  • 前端测试后端接口：postman
  • 后端提供接口，需要实时更新最新的消息和改动！

API框架

Restful Api文档在线生成工具=>Api文档和Api定义同步更新

依赖：

• swagger3集成的starter
• swagger2的依赖
  • swagger2
  • ui

Springboot集成Swagger

1. 新建一个项目Springboot=web

2. 导入相关依赖

    <dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-boot-starter</artifactId>
               <version>3.0.0</version>
           </dependency>
   
   

3. 添加注解@EnableOpenApi

   @SpringBootApplication
   @EnableOpenApi
   public class DemoSwagger3Application {
   
       public static void main(String[] args) {
           SpringApplication.run(DemoSwagger3Application.class, args);
       }
   
   }
   
   

4. 访问路径Swagger UI

5. 自定义页面信息Docket

   //自定义swagger页面
   @Configuration
   public class Swagger3 {
   
       @Bean
       public Docket docket() {
           return new Docket(DocumentationType.OAS_30).apiInfo(
                   new ApiInfoBuilder()
                           .contact(new Contact("erju", "", "825***@qq.com"))
                           .title("Swagger3测试项目")
                           .build()
           );
       }
   }