SpringBoot 中使用Swagger2

By | 五月 7, 2019

什么是Swagger

Swagger是一种REST APIs的简单但强大的表示方式,标准的,语言无关,这种表示方式不但人可读,而且机器可读。可以作为REST APIs的交互式文档,也可以作为REST APIs的形式化的接口描述,生成客户端和服务端的代码。

本教程基于 SpringBoot2 介绍 Swagger2 的使用

记得修改Swagger2Config 中设置的包路径RequestHandlerSelectors.basePackage(“com.example.demo”)

加入Maven依赖

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

编写Swagger全局配置

package com.example.demo.config;

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

/**
 * Swagger2配置
 */
@EnableSwagger2
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        //header中增加 token_id参数,没有可以去掉
        ParameterBuilder token = new ParameterBuilder();
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 指定自己项目路径
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文档标题
                .title("这里是文档标题")
                // 文档描述
                .description("这里是文档描述,http://www.jnnvc.com")
                .termsOfServiceUrl("这里可以增加需求文档 wiki 地址")
                .version("v1")//定义版本号
                .build();
    }

}

Controller 编写

package com.example.demo.controller;

import com.example.demo.model.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@Api(tags = "用户相关接口")
@RestController("user")
public class UserController {

    @ApiOperation(value = "用户用户", httpMethod = "GET", response = User.class)
    @GetMapping("/getUser")
    public User getUser(){
        User user = new User();
        user.setuId(123456789);
        user.setuName("www.jnnvc.com");
        return user;
    }

}

设置已上代码后启动项目:http://ip:port/swagger-ui.html
http://localhost:8080/swagger-ui.html