springboot 2 swagger2配置

最新推荐文章于 2024-06-21 10:00:00 发布

真理剑客

最新推荐文章于 2024-06-21 10:00:00 发布

阅读量416

点赞数

CC 4.0 BY-SA版权

分类专栏：框架、Spring、Springboot、SpringMVC

本文链接：https://blog.youkuaiyun.com/Veritas_C/article/details/81944211

框架、Spring、Springboot、SpringMVC 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在项目中集成Swagger2，通过Springfox实现RESTful API文档自动生成。包括pom.xml配置依赖、SwaggerConfig配置类编写及控制器示例。

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

pom.xml

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

        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
        </dependency>

SwaggerConfig.java

@Configuration 
@EnableSwagger2 
public class SwaggerConfig {
	
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API")
                .version("1.0")
                .build();
    }

    
}

简单使用

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

@Api(value=ApiTemplate.APP_ROOT_PATH,tags="XX模块")
@RequestMapping(ApiTemplate.V1 + "/users")
@RestController
public class UserController {
	
	@Autowired
	User user;
	
	@ApiOperation("获取所有用户")
	@GetMapping
	public List<User> getUsers() {
		List<User> list = new ArrayList<User>();
		return list;
	}
	
	@ApiOperation("获取某个用户")
	@GetMapping(value = "/{id}")
	public User getUser(@PathVariable Long id) {
		return user;
	}
	
	@ApiOperation("添加用户")
	@PostMapping
	public boolean insertUser(User user) {
		return true;
	}
	
	@ApiOperation(value="修改用户")
	@PutMapping
	@ApiImplicitParams({
	    @ApiImplicitParam(name="id",value="主键",required=true,dataType="int")
	})
	public User updateUser(User user) {
		return user;
	}
	
	@ApiOperation("删除用户")
	@DeleteMapping
	@ApiImplicitParams({
	    @ApiImplicitParam(name="ids",value="主键列表：1,2,3,4,5",required=true)
	})
	public Object deleteUser(Long[] ids) {
		return ids;
	}

@Api 将类标记为Swagger资源。
@ApiImplicitParam 表示API操作中的单个参数。
@ApiImplicitParams 允许多个ApiImplicitParam对象列表的包装器。
@ApiModel 提供有关Swagger型号的其他信息。
@ApiModelProperty 添加和操作模型属性的数据。
@ApiOperation 描述针对特定路径的操作或通常的HTTP方法。
@ApiParam 为操作参数添加额外的元数据。
@ApiResponse 描述操作的可能响应。
@ApiResponses 允许多个ApiResponse对象列表的包装器。
@Authorization 声明在资源或操作上使用授权方案。
@AuthorizationScope 描述OAuth2授权范围。
@ResponseHeader 表示可以作为响应的一部分提供的头。