swagger

依赖

        <!--swagger的依赖-->
        <!--2.9还是2.7以上可能会出错-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>javassist</artifactId>
                    <groupId>org.javassist</groupId>
                </exclusion>
            </exclusions>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <!--补充-->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>20.0</version>
        </dependency>
        <!--swagger导出-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>   

config类

package com.primeton.config;

import io.swagger.annotations.ApiOperation;
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.ApiKey;
import springfox.documentation.service.SecurityScheme;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI    //导出的注解
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //包下的类，生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.primeton.controller"))
                .paths(PathSelectors.any())
                .build();
    }


    //配置API的基本信息，会在http://项目实际地址/swagger-ui.html页面显示
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("EpApi")
                .description("ep文档")
                //地址：http://localhost:8010/swagger-ui.html
                .termsOfServiceUrl("http://localhost:8010")
                .version("1.0")
                .build();
    }
}

package com.primeton.config;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

public class WebMvcConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //静态资源路径
        registry.addResourceHandler("/**").addResourceLocations("calsspath:/static/");
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/sebjars");
        super.addResourceHandlers(registry);
    }
}

实体类

package com.primeton.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel("一个尝试")
public class Try {

    @ApiModelProperty("用户名")
    private String userName;

    @ApiModelProperty("密码")
    private String password;

    public Try(String userName, String password) {
        this.userName = userName;
        this.password = password;
    }

    public Try() {
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

Controller层

package com.primeton.controller;


import com.primeton.pojo.Try;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.*;


@RestController
@RequestMapping("test")
@Api(tags = "test")
public class TestController {

    @ApiOperation("添加用户")
    @PostMapping("add")
    public Try add(@ApiParam("用户名")@RequestParam("userName")String userName,
                    @ApiParam("密码")@RequestParam("password")String password){
        return new Try(userName,password);
    }

    @ApiOperation("修改")
    @PutMapping("/update")
    public String update(){
        return "修改";
    }




}