Spring Swagger注解生成接口文档

最新推荐文章于 2025-03-18 09:22:58 发布

JohnyLin37291

最新推荐文章于 2025-03-18 09:22:58 发布

阅读量506

点赞数

文章标签： java 接口文档 Spring Swagger restful

本文链接：https://blog.youkuaiyun.com/lin451791119/article/details/107490859

版权

本文介绍如何利用Spring Swagger通过简单的注解方式，轻松创建RESTful接口文档。首先在build.gradle中添加Swagger依赖，然后配置Swagger，接着使用Swagger注解来指定接口信息。启动服务后，访问http://localhost:7002/data-vip/doc.html即可查看生成的接口文档。

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

Spring Swagger通过注解就可以为我们生成接口文档，十分便捷！

首先，在build.grade配置文件中加入依赖

implementation 'org.apache.kafka:kafka-clients'
implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

加入Swagger的配置

/**
 * @author linzihao
 */
@Configuration
@EnableSwagger2
@ConditionalOnProperty(prefix = "swagger2", value = {"enable"}, havingValue = "true")
public class Swagger2Config {

    //http://localhost:7002/data-vip/doc.html
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).pathMapping("/").select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(new ApiInfoBuilder()