swagger2 文档_swagger2官方版中文版-优快云博客

本文档介绍如何集成Swagger2到项目中，包括添加依赖、配置SwaggerConfig.java以及在Controller中使用@ApiOperation和@ApiImplicitParam注解来生成详细的API文档。通过这些步骤，开发者可以方便地展示和测试API接口。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

加入swagger2依赖

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

配置SwaggerConfig.java

package com.offcn.springbootdemo1.config;

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;

@Configuration
@EnableSwagger2 //开启在线文档
public class SwaggerConfig {
    //1.声明api  文档的属性 构建器
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder().title("springBoot中使用RestFul")
                .description("是是是").termsOfServiceUrl("http://www.ujiuye.com/")
                .contact("wjy").version("1.0").build();
    }

    //2.配置核心配置信息
    public Docket createApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select().apis(RequestHandlerSelectors.basePackage("com.offcn.springbootdemo1.controller"))
                .paths(PathSelectors.any()).build();
    }
}

在controller类中添加注解@ApiOperation，@ApiImplicitParam（多个数据用@ApiImplicitParams）

package com.offcn.springbootdemo1.controller;

import com.offcn.springbootdemo1.po.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.ArrayList;
import java.util.Collections;
import java.util.List;

@RestController
@RequestMapping("/user_con")
public class UserController {

    private List<User> listUser= Collections.synchronizedList(new ArrayList<User>());
    @GetMapping("/")
    public List<User> getUser(){
        return listUser;
    }
    @PostMapping("/")
    @ApiOperation(value = "插入数据信息",notes = "添加用户")
    @ApiImplicitParam(name = "user",value = "用户实体类user",required = true,dataType = "User")
    public String insetUser(User user){
        listUser.add(user);
        return "success";
    }

    @PutMapping("/{age}")
    @ApiOperation(value="更新指定id用户信息", notes="根据id更新用户信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "age", value = "用户年龄", required = true, dataType = "Integer"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    public String updateUser(@PathVariable("age") Integer age,User user) {
        for (User user2 : listUser) {
            if(user2.getAge()==age) {
                user2.setName(user.getName());
                user2.setHobby(user.getHobby());
            }
        }
        return "success";
    }
}