Spring boot篇 swagger API文档的框架

配置pom.xml

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>
    <!--swagger 引入 end-->

配置config

package com.demo.shop.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.demo.shop.controller"))// 注意修改此处的包名
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口列表 v1.1.0") // 任意，请稍微规范点
                .description("接口测试") // 任意，请稍微规范点
                .termsOfServiceUrl("http://localhost:8080/shop-web") // 将“url”换成自己的ip:port
                .contact("xxxx") // 无所谓（这里是作者的别称）
                .version("1.1.0")
                .build();
    }
}

运行效果

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

RequestHandlerSelectors.basePackage(“com.demo.shop.controller”)
设置扫描的路径

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Controller
@RequestMapping("/address")
@Api(description = "收货地址管理")
public class AddressController {

    @ApiOperation(value = "获得用户的默认地址", httpMethod = "POST", notes = "根据用户id( userId) 查询默认地址。")
    @ApiImplicitParams({
            @ApiImplicitParam(required = true, name = "userId", value = "用户id " ,paramType = "query" , dataType = "Long")
    })
    @PostMapping(value = "/getAddressByUserId")
    @ResponseBody
    public void getAddressByUserId(HttpServletResponse response, HttpServletRequest request,
                                             @RequestParam(value = "userId", required = true) Long userId) {
    }

}