SpringBoot整合swagger的简单配置

虽然辛苦，我还是会选择那种滚烫的人生。——北野武

swagger

简介

swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger
是一个规范和完整的框架，用于生成、描述、调用和可视化restful 风格的 Web 服务。
总体目标是使客户端和文件系统作为服务器以同样的速度来更新。 文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

注解

@Api：用在请求的类上，表示对类的说明
	tags="说明该类的作用，可以在UI界面上看到的注解"
	value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
	value="说明方法的用途、作用"
	notes="方法的备注说明"

@ApiParam：用于方法，参数，字段说明，表示对参数的添加元数据（说明或是否必填等）
	name:属性名称
	value：属性值
	defaultValue：默认属性值
	required：是否属性必填
	example：举例子

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
	@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
		name：参数名
		value：参数的汉字说明、解释
		required：参数是否必须传
		paramType：参数放在哪个地方
			· header --> 请求参数的获取：@RequestHeader
			· query --> 请求参数的获取：@RequestParam
			· path（用于restful接口）--> 请求参数的获取：@PathVariable
			. body（不常用）
			· form（不常用）
		dataType：参数类型，默认String，其它值dataType="Integer"
		defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
	@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
		code：数字，例如400
		message：信息，例如"请求参数没填好"
		response：抛出异常的类
		
@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
	@ApiModelProperty：用在属性上，描述响应类的属性

配置步骤

• 建立好一个用spring data jpa（其他都可以）搭建的基本查询结构。
• 在原来的依赖基础上添加swagger相关依赖

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

• 在application.properties文件中定义需要的参数，以下参数是自定义的，可以定义自己想要的参数

swagger.basepackage=com.yuxi
swagger.title=admin crud jpa swagger
swagger.version=v1.0
swagger.description=this is admin crud function
swagger.url=http://www.admin.com
swagger.contact=yuxi

• 建立一个swagger的配置类，用来将配置文件中的信息引入进来，注意在类，属性，方法上边分别添加的注解。

package com.yuxi.config;

import org.springframework.beans.factory.annotation.Value;
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;

/**
 * @author Administrator
 * 配置swagger的相关配置
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Value("${swagger.title}")
    private String title;

    @Value("${swagger.basepackage}")
    private String basePackage;

    @Value("${swagger.version}")
    private String version;

    @Value("${swagger.description}")
    private String description;

    @Value("${swagger.url}")
    private String url;

    @Value("${swagger.contact}")
    private String contact;

    @Bean
    public Docket getDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getApi())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo getApi() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(url)
                .version(version)
                .contact(new Contact(contact,url,url))
                .build();
    }
}

• 在controller层中添加相关信息，比如@ApiOperation(value = "获取全部的管理员对象")注解表示在界面中描述该方法的作用

package com.yuxi.controller;

import com.yuxi.entity.Admin;
import com.yuxi.service.AdminService;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;

@RestController
public class AdminController {

    @Resource
    private AdminService service;

    @GetMapping("/user")
    @ApiOperation(value = "获取全部的管理员对象")
    public List<Admin> all(){
        return service.findAll();
    }

    @GetMapping("/user/{id}")
    public Admin gitAdminById(@PathVariable int  id){
        return service.findAdminByUid(id);
    }
}

• 启动服务，访问localhost:8080/swagger-ui.html，注意后边的swagger-ui.html是不可变的，必须是该地址，如果出现如下界面，表示配置成功
  

• 比如点击gitAdminById可以显示出如下的界面，在界面中有输入ID的输入框，可以查询对应ID的相关信息。

• 此外，还可以添加删除，新增等其他方法。