springboot整合swagger【详细教程】

今天爱分享给大家带来springboot整合swagger【详细教程】,希望能帮到大家。

使用方法

1.两个pom依赖

		<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>
  1. 配置类
    使用@Configuration注解标注,作为配置类,以供spring启动是加载
    @EnableSwagger2启动swagger
		
package cn.timebusker.conf;

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;

/**
 * 通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。
 * 再通过createRestApi函数创建Docket的Bean之后, apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。
 * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,
 * 本例采用指定扫描的包路径来定义,Swagger会扫描该包下所有Controller定义的API, 并产生文档内容(除了被@ApiIgnore指定的请求)。
 * 
 * 添加文档内容
 * 
 * 在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,
 * 而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。
 * 如:我们通过@ApiOperation注解来给API增加说明、
 * 通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。
 * 
 */
@Configuration
@EnableSwagger2
public class Swagger2Configuration {

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

	/**
	 * Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
	 * 总体目标是使客户端和文件系统作为服务器以同样的速度来更新。 文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
	 * Swagger 让部署管理和使用功能强大的API从未如此简单。
	 * 
	 * 前后端分离开发 API文档非常明确 测试的时候不需要再使用URL输入浏览器的方式来访问Controller
	 * 传统的输入URL的测试方式对于post请求的传参比较麻烦(当然,可以使用postman这样的浏览器插件)
	 * spring-boot与swagger的集成简单的一逼
	 */
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
		           .apiInfo(apiInfo()).select()
		           // basePackage: 是接口的包名
		           .apis(RequestHandlerSelectors.basePackage("cn.timebusker"))
		           .paths(PathSelectors.any())
		           .build();
	}
	
	private ApiInfo apiInfo() {
		Contact contact = new Contact("timebusker", "timebusker@vip.qq.com", "576697722");
		return new ApiInfoBuilder()
		           .title("Spring Boot中使用Swagger2构建RESTful APIs")
		           .description("更多Spring Boot相关实践请关注:https://github.com/timebusker/spring-boot")
		           .termsOfServiceUrl("https://github.com/timebusker/spring-boot/tree/master/spring-boot-12-Swagger2/")
		           .contact(contact)
		           .version("2.0.0")
		           .build();
	}

}
  1. 对于接口的配置
package cn.timebusker.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import cn.timebusker.domain.User;

@Api("UserController 接口")
@RestController
@RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下,可去除
public class UserController {

    @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }
}


@Api:用在类上,说明该类的作用
@ApiOperation:用在方法上,说明方法的作用
@ApiImplicitParams:用在方法上包含一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面。name:参数名; dataType:参数类型; required:参数是否必须传; value:参数的意思;defaultValue:参数的默认值

  1. 对于Vo的设置
package cn.timebusker.domain;

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

@ApiModel("用户类")
public class User {

    @ApiModelProperty("用户id")
    private Long id;
    @ApiModelProperty("用户名称")
    private String name;
    @ApiModelProperty("用户年龄")
    private Integer age;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

@ApiModel:描述一个Model的信息
@ApiModelProperty:描述一个model的属性

  1. 查看接口文档信息
    请求地址: http://localhost:8080/swagger-ui.html(端口对应项目的端口)

springboot整合swagger【详细教程】插图
springboot整合swagger【详细教程】插图(1)

人已赞赏
Java

java Random 方法在for循环内和外有什么不同【详细讲解】

2020-11-3 16:40:04

Java

线程和进程的区别?【面试题详解】

2020-11-6 13:45:50

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
'); })();