Swagger

最新推荐文章于 2024-07-21 22:27:18 发布

诗诗Pure

最新推荐文章于 2024-07-21 22:27:18 发布

阅读量414

点赞数 3

文章标签： java spring boot vue.js

本文链接：https://blog.csdn.net/BubblesMusic/article/details/121766768

版权

学习目标

了解Swagger的作用和概念

了解前后端分离

在Spring Boot中集成Swagger

Swagger简介

前后端分离

Vue + SpringBoot

后端时代：前端只用管理静态页面； html==>后端。模板引擎 JSP => 后端是主力

前后端分离式时代

后端：后端控制层，服务层，数据访问层【后端团队】

前端：前端控制层，视图层【前端团队】

伪造后端数据，json。已经存在了，不需要后端，前端工程依旧能够跑起来

前端后如何交互？===>Apl

前后端相对独立，松耦合；

前后端甚至可以部署在不同的服务器上；

产生一个问题

前后端集成联调，前端人员和后端人员无法做到即使协商，尽早解决，最终导致问题集中爆发；

解决方案

首先指定schema[计划的提纲],实时更新最新APl，降低集成的风险；

早些年：指定word计划文档；

前后端分离

前端测试后端接口：postman

后端提供接口，需要实时更新最新的消息及改动！

Swagger

号称世界上最流行的Api框架

RestFul Api 文档在线自动生成工具=> Api文档与Apl定义同步更新

直接运行，可以在线测试APl接口；

支持多种语言：（java ，php......等）

官网：API Documentation & Design Tools for Teams | Swagger

在项目中使用Swagger需要springbox

Swagger2
ui

SpringBoot 集成Swagger

1.新建一个SpringBoot = web项目

2.导入相关依赖

springfox-swagger2和springfox-swagger-ui

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> 
<dependency> 
<groupId>io.springfox</groupId>
 <artifactId>springfox-swagger2</artifactId>
 <version>3.0.0</version> </dependency> 
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> 
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger-ui</artifactId>
 <version>3.0.0</version> 
</dependency>

3.编写一个hello工程，检验程序是否能跑动

4.配置Swagger==> Config

@Configuration

@EnableSwagger2 //开启Swagger2

public class Swaggerconfig { }

5.测试运行

配置Swagger

Swagger的bean实例Docket;

package com.bubbles.swagger.config; 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo; 
import springfox.documentation.service.Contact; 
import springfox.documentation.spi.DocumentationType; 
import springfox.documentation.spring.web.plugins.Docket; 
import springfox.documentation.swagger2.annotations.EnableSwagger2; 
import java.util.ArrayList;
@Configuration
@EnableSwagger2 //开启Swagger2 
public class Swaggerconfig { 
//配置了Swagger的Docket的bean实例
@Bean 
public Docket docket(){ 
return new Docket (DocumentationType.SWAGGER_2).apiInfo (apiInfo ()); 
} 
//作者信息 
Contact contact =new Contact ("彬哥","https://www.baidu.com/","2019882328@qq.com"); //配置Swagger信息=apiInfo private ApiInfo apiInfo(){ return new ApiInfo ( "Bubbles的SwaggerApl文档日记", "只要努力就能改变命运", "v1.0", "https://www.baidu.com/", contact, "Apahe 2.0", "https://www.apache.org/licenses/LICENSE-2.0", new ArrayList()); } }

结果

Swagger配置扫描接口

Docket.select(）

//配置了Swagger的Docket的bean实例
 @Bean 
public Docket docket(){
 return new Docket (DocumentationType.SWAGGER_2) .apiInfo (apiInfo ()) .select () //RequestHandlerSelectors：配置要扫描接口的方式 
//basePackage：指定要扫描的包 
//any：扫描全部
 //none：都不扫描
 //withClassAnnotation ：扫描类上的注解，参数是一个注解的反射对象 
//withMethodAnnotation扫描方法上的注解 .apis (RequestHandlerSelectors.basePackage ("com.bubbles.swagger.controller"))
 //paths ：过滤什么路径 .paths (PathSelectors.ant ("/bubbles/**")) .build (); }

配置是否启动Swagger

//配置了Swagger的Docket的bean实例
 @Bean 
public Docket docket(){ 
return new Docket (DocumentationType.SWAGGER_2) .apiInfo (apiInfo ()) .enable (false) //enable是否启动Swagger，如果为False,则Swagger不能再浏览中访问 .select () //RequestHandlerSelectors：配置要扫描接口的方式
 //basePackage：指定要扫描的包 
//any：扫描全部 
//none：都不扫描 
//withClassAnnotation ：扫描类上的注解，参数是一个注解的反射对象
 //withMethodAnnotation扫描方法上的注解 .apis (RequestHandlerSelectors.basePackage ("com.bubbles.swagger.controller")) 
//paths ：过滤什么路径 
//.paths (PathSelectors.ant ("/bubbles/**")) .build ();

我只希望我的Swagger在生产环境中使用，在发布的时候不使用？

判断是不是生存环境 flag = false

注入enable（flag）

//配置了Swagger的Docket的bean实例
 @Bean
 public Docket docket(Environment environment){ 
//设置要显示的Swagger环境
 Profiles profiles = Profiles.of ("dev","test"); 
//通过environment.acceptsProfiles判断是否处在自己设定的环境当中
 boolean flag = environment.acceptsProfiles (profiles); 
return new Docket (DocumentationType.SWAGGER_2) .apiInfo (apiInfo ()) .enable (flag) //enable是否启动Swagger，如果为False,则Swagger不能再浏览中访问 .select () //RequestHandlerSelectors：配置要扫描接口的方式 
//basePackage：指定要扫描的包 
//any：扫描全部
 //none：都不扫描 
//withClassAnnotation ：扫描类上的注解，参数是一个注解的反射对象
 //withMethodAnnotation扫描方法上的注解 .apis (RequestHandlerSelectors.basePackage ("com.bubbles.swagger.controller")) 
//paths ：过滤什么路径
 //.paths (PathSelectors.ant ("/bubbles/**")) .build ();

配置APl文档的分组

.groupName ("bubbles")

如何配置多个分组；多个Docket实例即可

@Bean 
 public Docket docket1(){ 
 return new Docket (DocumentationType.SWAGGER_2).groupName ("A"); 
}
 @Bean
 public Docket docket2(){
 return new Docket (DocumentationType.SWAGGER_2).groupName ("b"); 
} 
 @Bean 
 public Docket docket3(){ 
 return new Docket (DocumentationType.SWAGGER_2).groupName ("c");
 }

实体类配置

package com.bubbles.swagger.pojo; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; //@Api(注释) @ApiModel("用户实体类") public class User { @ApiModelProperty("用户名") public String username; @ApiModelProperty("密码") public String password; }

controller

package com.bubbles.swagger.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment; import org.springframework.core.env.Profiles; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; @Configuration @EnableSwagger2//开启Swagger2 public class Swaggerconfig { @Bean public Docket docket1(){ return new Docket (DocumentationType.SWAGGER_2).groupName ("A"); } @Bean public Docket docket2(){ return new Docket (DocumentationType.SWAGGER_2).groupName ("b"); } @Bean public Docket docket3(){ return new Docket (DocumentationType.SWAGGER_2).groupName ("c"); } //配置了Swagger的Docket的bean实例 @Bean public Docket docket(Environment environment){ //设置要显示的Swagger环境 Profiles profiles = Profiles.of ("dev","test"); //通过environment.acceptsProfiles判断是否处在自己设定的环境当中 boolean flag = environment.acceptsProfiles (profiles); return new Docket (DocumentationType.SWAGGER_2) .apiInfo (apiInfo ()) .groupName ("bubbles") .enable (flag) //enable是否启动Swagger，如果为False,则Swagger不能再浏览中访问 .select () //RequestHandlerSelectors：配置要扫描接口的方式 //basePackage：指定要扫描的包 //any：扫描全部 //none：都不扫描 //withClassAnnotation ：扫描类上的注解，参数是一个注解的反射对象 //withMethodAnnotation扫描方法上的注解 .apis (RequestHandlerSelectors.basePackage ("com.bubbles.swagger.controller")) //paths ：过滤什么路径 //.paths (PathSelectors.ant ("/bubbles/**")) .build (); } //作者信息 Contact contact =new Contact ("彬哥","https://www.baidu.com/","2019882328@qq.com"); //配置Swagger信息=apiInfo private ApiInfo apiInfo(){ return new ApiInfo ( "Bubbles的SwaggerApl文档日记", "只要努力就能改变命运", "v1.0", "https://www.baidu.com/", contact, "Apahe 2.0", "https://www.apache.org/licenses/LICENSE-2.0", new ArrayList()); } } package com.bubbles.swagger.controller; import com.bubbles.swagger.pojo.User; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class Hellocontroller { @GetMapping (value = "/hello") public String hello (){ return "hello"; } //只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中 @RequestMapping(value = "/user") public User user(){ return new User(); } //Operation接口,添加中文注释,不是放在类上的，是方法 @ApiOperation ("Hello控制类") @GetMapping(value = "/hello2") public String hello2(@ApiParam("用户名") String username){ return "hello"+username; } @ApiOperation ("Post测试类") @PostMapping (value = "/postt") public User postt(@ApiParam("用户名") User user){ int i = 5/0; return user; } }

总结

1.我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息

2.接口文档实时更新

3.可以在线测试 ‘

Swagger是一个优秀的工具，几乎所有的大公司都有使用它

【注意点】在正式发布的时候，关闭Swagger ！！！出于安全考虑。而且节省运行的内存；

诗诗Pure

关注

3
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Swagger

学习目标了解Swagger的作用和概念了解前后端分离在Spring Boot中集成SwaggerSwagger简介前后端分离Vue + SpringBoot后端时代：前端只用管理静态页面； html==>后端。模板引擎 JSP => 后端是主力前后端分离式时代后端：后端控制层，服务层，数据访问层【后端团队】前端：前端控制层，视图层【前端团队】伪造后端数据，json。已经存在了，不需要后端，前端工程依旧能够跑起来前端后如何交互？==.
复制链接

扫一扫