spring boot .Swagger2

最新推荐文章于 2026-01-06 16:02:56 发布

原创最新推荐文章于 2026-01-06 16:02:56 发布 · 245 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot

spring boot 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何使用Swagger2在Spring Boot项目中快速搭建RESTful API文档，包括添加依赖、配置Swagger2信息及创建Controller类的方法。

Swagger2 良好的restful 可视化工具包

最终效果：

1.添加依赖jar包：

 <!-- 添加 resutful 可视化 Swagger2  -->

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

2.创建Swagger2 的信息和配置bean

package com.example;

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;

/**
 * @Author lin
 * @date 2019/1/10 11:13
 */

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.web"))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("swagger2学习")
                .termsOfServiceUrl("url")
                .contact("linyf")
                .version("1.0")
                .build();
    }

}

3.创建controller 类

package com.example.web;

import com.example.domain.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import java.util.*;

/**
 * @Author lin
 * @date 2019/1/10 10:17
 */
@RestController
@RequestMapping(value = "/users")
public class UserController {

    //创建线程安全的Map
    static Map<Long, User> users= Collections.synchronizedMap(new HashMap<>());

    //添加说明
    @ApiOperation(value = "获取用户列表",notes = "GET")

    @RequestMapping(value = "/" ,method = RequestMethod.GET)
    public List<User> getUserList(){

        //处理“/user/" 的GET请求，用来获取用户列表
        //通过 @RequestParam 获取参数
        List<User> r =new ArrayList<>(users.values());
        return r;
    }

    @ApiOperation(value = "创建用户",notes = "根据User对象创建用户POST")
    @ApiImplicitParam(name = "user" ,value = "用户详细实体user")

    @RequestMapping(value = "/" ,method = RequestMethod.POST)
    public String postUser(@ModelAttribute User user){
        //处理"/users/"的POST请求，用来创建User
        //通过ModelAttribute 绑定参数
        users.put(user.getId(),user);

        return "success";

    }

    @ApiOperation(value = "获取用户详细信息",notes = "根据用户id 查询用户信息GET")
    @ApiImplicitParam(name = "id" ,value = "用户id", required = true, dataType = "Long")

    @RequestMapping(value="/{id}" , method = RequestMethod.GET)
    public User getUser(@PathVariable(required = true) Long id){
        // 处理"/users/{id}"的GET请求，用来获取url中id值的User信息
        //通过PathVarible 绑定到函数的参数中
        return users.get(id);
    }

    @ApiOperation(value = "更新用户",notes = "根据用户id 更新user对象POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "id", value = "user实体对象", required = true, dataType = "User")
    })
    @RequestMapping(value = "/{id}",method = RequestMethod.POST)
    public String putUser(@PathVariable Long id ,@ModelAttribute User user){
        // 处理"/users/{id}"的PUT请求，用来更新User信息

        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }




    @ApiOperation(value = "删除用户",notes = "根据用户id 删除用户 DELETE")
    @ApiImplicitParam(name = "id", value = "用户id", required = true,dataType = "Long")

    @RequestMapping(value =  "/{id}" , method = RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id){
        // 处理"/users/{id}"的DELETE请求，用来删除User
        users.remove(id);
        return "success";
    }

}