swagger2超快速入门

Swagger2超快速入门

swagger是一款非常好用的自动生成接口文档的插件，实现API文档与API定义同步更新。

项目中使用swagger

1.新建一个springboot项目

2.导入相关依赖

		<!--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>

3.编写一个接口

4.配置swagger

package com.example.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.w3c.dom.Document;
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;

import static springfox.documentation.service.ApiInfo.DEFAULT_CONTACT;

/**
 * @Description:
 * @ClassName: SwaggerConfig
 * @Author: yokna
 * @Date: 2021/10/9 10:14
 * @Version: 1.0
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("yokna","","yokna623660@163.com");
        return new ApiInfo("echat的api文档",
                "一个在线聊天系统",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }
}

5.访问swagger-ui

Swagger UI

至此，就可以访问到swagger的接口文档了。