不需要启动完整的ApplicationContext,创建openapi文档。
创始人
2025-01-10 14:30:24
0

以下是一个使用Spring Boot和Springfox来创建OpenAPI文档的示例代码:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
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;

@SpringBootApplication
@EnableSwagger2
public class OpenApiApplication {

    public static void main(String[] args) {
        SpringApplication.run(OpenApiApplication.class, args);
    }

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.api")) // 指定API包路径
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("这是一个示例API文档")
                .version("1.0")
                .build();
    }
}

在上面的例子中,我们使用了Spring Boot和Springfox的依赖来创建OpenAPI文档。通过@SpringBootApplication注解,我们创建了一个Spring Boot应用程序。使用@EnableSwagger2注解启用Swagger支持。

通过@Bean注解创建了一个Docket bean,该bean用于配置Swagger文档的生成规则。我们可以通过apis方法来指定要包含在文档中的API的包路径,通过paths方法来指定要包含的API的路径。在这个例子中,我们将所有的API都包含在文档中。

apiInfo方法用于设置文档的标题、描述和版本等信息。在上面的例子中,我们使用了一些示例信息。

最后,通过调用SpringApplication.run方法来启动应用程序。在应用程序启动后,您可以访问http://localhost:8080/swagger-ui.html来查看生成的OpenAPI文档。

相关内容

热门资讯

两分钟了解!蜀山四川麻将有挂吗... 两分钟了解!蜀山四川麻将有挂吗,大宝麻将辅助器app,可靠技巧(有挂辅助);1、该软件可以轻松地帮助...
两分钟了解!衢州都莱辅助器,牌... 两分钟了解!衢州都莱辅助器,牌乐门手机麻将有什么,2025新版技巧(有挂技巧)1、下载好牌乐门手机麻...
五分钟了解!福建十三水软件开发... 五分钟了解!福建十三水软件开发,八闽十三张软件,AI教程(有挂普及)1、超多福利:超高返利,海量正版...
6分钟了解!途乐棋牌这个平台靠... 6分钟了解!途乐棋牌这个平台靠谱吗,中至麻将可以设置输赢吗,必赢方法(有挂脚本)1、操作简单,无需注...
四分钟了解!快玩炸翻天辅助器,... 四分钟了解!快玩炸翻天辅助器,星悦广东麻将有没有挂,普及教程(有挂揭秘)1、星悦广东麻将有没有挂系统...
九分钟了解!掌酷十三张系统规律... 九分钟了解!掌酷十三张系统规律,掌电竞技真的能赢吗,大神讲解(有挂揭秘);1、玩家可以在掌电竞技真的...
9分钟了解!蛮籽重庆麻将有没有... 9分钟了解!蛮籽重庆麻将有没有挂,八闽十三张有外挂吗,必胜教程(有挂解密)1、上手简单,内置详细流程...
8分钟了解!微信牵手跑得快小程... 8分钟了解!微信牵手跑得快小程序辅助器免费,牌乐门如何拿到好牌,技巧教程(有挂透明);1、每一步都需...
两分钟了解!老友游戏辅助器,财... 两分钟了解!老友游戏辅助器,财神13张 辅助器,2025新版教程(有挂工具)财神13张 辅助器辅助器...
二分钟了解!新玉海楼茶苑有没有... 二分钟了解!新玉海楼茶苑有没有外 挂,牵手互娱有挂吗,详细教程(有挂普及)小薇(透视辅助)致您一封信...