springboot 2 swagger2配置

pom.xml

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
        </dependency>

SwaggerConfig.java

@Configuration 
@EnableSwagger2 
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API")
                .version("1.0")
                .build();
    }


}

簡單使用

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

@Api(value=ApiTemplate.APP_ROOT_PATH,tags="登錄模塊")
@RequestMapping(ApiTemplate.V1 + "/users")
@RestController
public class UserController {

    @Autowired
    User user;

    @ApiOperation("獲取所有用戶")
    @GetMapping
    public List<User> getUsers() {
        List<User> list = new ArrayList<User>();
        return list;
    }

    @ApiOperation("獲取某個用戶")
    @GetMapping(value = "/{id}")
    public User getUser(@PathVariable Long id) {
        return user;
    }

    @ApiOperation("添加用戶")
    @PostMapping
    public boolean addUser(User user) {
        return true;
    }

    @ApiOperation(value="修改用戶")
    @PutMapping
    @ApiImplicitParams({
        @ApiImplicitParam(name="id",value="主鍵",required=true,dataType="int")
    })
    public User modifyUser(User user) {
        return user;
    }

    @ApiOperation("刪除用戶")
    @DeleteMapping
    @ApiImplicitParams({
        @ApiImplicitParam(name="ids",value="主鍵列表：1,2,3,4,5",required=true)
    })
    public Object delUser(Long[] ids) {
        return ids;
    }

@Api 將類標記爲Swagger資源。
@ApiImplicitParam 表示API操作中的單個參數。
@ApiImplicitParams 允許多個ApiImplicitParam對象列表的包裝器。
@ApiModel 提供有關Swagger型號的其他信息。
@ApiModelProperty 添加和操作模型屬性的數據。
@ApiOperation 描述針對特定路徑的操作或通常的HTTP方法。
@ApiParam 爲操作參數添加額外的元數據。
@ApiResponse 描述操作的可能響應。
@ApiResponses 允許多個ApiResponse對象列表的包裝器。
@Authorization 聲明在資源或操作上使用授權方案。
@AuthorizationScope 描述OAuth2授權範圍。
@ResponseHeader 表示可以作爲響應的一部分提供的頭。