不需要启动完整的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文档。

相关内容

热门资讯

推荐一款(aa扑克辅助)外挂透... 推荐一款(aa扑克辅助)外挂透明挂辅助机制(辅助挂)确实真的有挂(2024已更新)(哔哩哔哩);玩家...
重大通报!WPK控制(Wepo... 《WPK控制软件透明挂》是一款多人竞技的WPK控制辅助透视游戏,你将微扑克对手来到同一个战场,为至高...
玩家必看科普(wpk辅助器)外... 《wpk辅助器软件透明挂》是一款多人竞技的wpk辅助器辅助透视游戏,你将微扑克对手来到同一个战场,为...
透明插件(wepoke黑科技)... 透明插件(wepoke黑科技)外挂透明挂辅助APP(透视)软件透明挂(确实有挂)-哔哩哔哩1、点击下...
重大通报(红龙扑克发牌)外挂透... 此外,数据分析德州(红龙扑克发牌)辅助神器app还具备辅助透视行为开挂功能,通过对客户红龙扑克发牌透...
必备科技!WPK苹果(wepo... 1、必备科技!WPK苹果(wepoKe)外挂透明挂辅助器安装(辅助挂)曝光教程(果真有挂)-哔哩哔哩...
透视免费(鱼扑克软件)外挂透明... 透视免费(鱼扑克软件)外挂透明挂辅助神器(透视)辅助透视(确实有挂)-哔哩哔哩;亲真的是有正版授权,...
分享认知(wpk机制)外挂透明... 分享认知(wpk机制)外挂透明挂辅助神器(辅助挂)德州ai机器人(有挂辅助)-哔哩哔哩是由北京得wp...
玩家必看攻略(Wepoke代打... 玩家必看攻略(Wepoke代打)外挂透明挂辅助app(透视)的确真的有挂(2024已更新)(哔哩哔哩...
八分钟了解!wpk实测(weP... 八分钟了解!wpk实测(wePoke)外挂透明挂辅助神器(透视)必胜教程(新版有挂)-哔哩哔哩;原来...