Only老K说-Swagger

Swagger简介

来源还是因为前后端分离。简单理解就是写API的

环境准备

使用SpringBoot创建一个项目

导入Pom

        <!--Swagger依赖-->
            <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>
        <!--Swagger依赖结束-->

编写代码测试

新建一个配置类 后续的Swagger的配置都是在这个里面完成

package com.onlyk.swaggerdome.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author only老K 我为自己代言
 * @create 2020-07-02 19:34
 * @blogaddress https://blog.youkuaiyun.com/weixin_44255950
 */
@Configuration //声明是配置类
@EnableSwagger2 //开启Swagger自动配置
public class swaggerConfig {
}

写个测试类

package com.onlyk.swaggerdome.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author only老K 我为自己代言
 * @create 2020-07-02 19:35
 * @blogaddress https://blog.youkuaiyun.com/weixin_44255950
 */
@Controller
public class swaggerController {
    @RequestMapping("/hello")
    @ResponseBody
    public String helloSwagger(){
        return "hello Swagger";
    }
}

http://localhost:8081/swagger-ui.html

配置Swagger信息

package com.onlyk.swaggerdome.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;

/**
 * @author only老K 我为自己代言
 * @create 2020-07-02 19:34
 * @blogaddress https://blog.youkuaiyun.com/weixin_44255950
 */
@Configuration //声明是配置类
@EnableSwagger2 //开启Swagger自动配置
public class swaggerConfig {
    //配置swagger的Docket实例
    @Bean
    public Docket getDocket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }
    /**
     * 配置Swagger 信息==ApiInfo
     */
    private ApiInfo apiInfo(){
        //配置信息
        Contact contact=new Contact("only老K","https://blog.youkuaiyun.com/weixin_44255950","No Email");
        return new ApiInfo(
                "老K的SwaggerAPI文档",
                "Only老K，我为自己带盐",
                "v1.0",
                "https://blog.youkuaiyun.com/weixin_44255950",
                contact,
                "Apache2.0",
                "https://blog.youkuaiyun.com/weixin_44255950",
                new ArrayList<>()
        );
    }
}

重启启动，后页面不一样了，加载了配置信息