Spingboot整合Swagger

一、swagger简介

        接口文档 开发时尤其是进入公司时没有文档是很头疼的事，swagger提供简化接口文档的开发Restful风格。

二、快速上手

        1.  导入pom.xml依赖

pom.xml

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

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

         2.  编写配置类

                写配置类都要加上注解

              @Configuragtion:标注此类为配置类

              @EnableSwagger2：引入的swagger2

package com.example.spingbootswagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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
public class SwaggerConfig {
    //配置Swagger的Docket的Bean实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.spingbootswagger.controller"))
                    .build();
    }

    public ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact("admin","http://www.bai.com","[e-mail]");
        return new ApiInfo(
                "admin的api文档",
                "没有方向的小船风往哪吹都是逆风",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }

}

    

启动之后输入 localhost:8080/swagger-ui.html出现这样页面就成功了

                方法声明

                                apIInfo参数表

类型	参数名	作用	默认值
String	title	标题	ApI Docuentation
String	description	描述	ApI Docuentation
String	termsOfServiceUrl	服务条款网址	urn:tos
String	license	许可	Apache 2.0
String	licenseUrl	许可链接	http://www.apache.org/licenses/LICENSE-2.0
String	version	版本	1.0
Contact	Contact	维护人信息	null

                               Contact参数表

                                

类型	参数名	作用	默认值
String	name	作者名	null
String	url	地址链接	null
String	email	邮箱	null