springboot+swagger2

Swagger2的介绍

1.随项目自动生成强大RESTful API文档，减少工作量
2.API文档与代码整合在一起，便于同步更新API说明
3.页面测试功能来调试每个RESTful API

开始流程

1.导入依赖

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.7.0</version>
    </dependency>
    <!-- Swagger第三方ui依赖 -->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.6</version>
    </dependency>

2.编写swagger的配置类

package com.ishang.medicine.medicine.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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.List;


/**
 * Swagger2配置
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {//规定扫描包下的注解
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("medicine")
                .select()
                //为当前包下的controller生成api文档

                .apis(RequestHandlerSelectors.basePackage("com.ishang.medicine.medicine.controller"))//controller的路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        //设置文档信息
        return new ApiInfoBuilder()
                .title("测试接口文档")
                .description("文档名字")
                .contact(new Contact("medicine", "https://localhost:8082/doc.html",
                        "xxxx@xxxx.com"))
                .version("1.0")
                .build();
    }
    
}

3.编写Controller类

@Api(tags = "名字")//接口名字
public class Mycontroller {

    @ApiOperation(value = "方法名")
    public String hello(){
        return "helloword";
    }
}