swagger简单的了解

swagger技术

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

• RestFul Api 文档在线自动生成工具==>Api文档自动更新；

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

• 支持多种语言；（java，Php…）;

官网：https://swagger.io/

在项目中使用Swagger需要架包springbox，其中需要两个jar包，

• swagger2
• swagger-ui

Springboot 集成swagger

1. 新建立一个SpringBoot–web的项目

2. 导入相关依赖

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

3. 编写一个hellow请求。

4. 配置swagger=====>书写config类

   
   @Configuration
   @EnableSwagger2     //  开启swagger2
   public class SwaggerConfig {
        
   }
   
   

5. 启动项目访问：http://localhost:8080/swagger-ui.html#/hellow-control

6. [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-aOalSaT7-1595126734546)(C:\Users\傻孩子\AppData\Roaming\Typora\typora-user-images\image-20200718153427032.png)]

配置Swagger

看源码配置，尝试改变源码来增加自己的理解。这就是渐渐的看源码的过程，是一个很好的学习的过程。

@Configuration
@EnableSwagger2     //  开启swagger2
public class SwaggerConfig {
   

//  配置swagger的Docker 的bean实例
  @Bean
  public Docket docket(){
   //    进行修改apiInfo来感受一下怎么去找源码，看源码。
    return new Docket(DocumentationType.SWAGGER_2)