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

相关内容

热门资讯

不少玩家反映!衢州都莱辅助器免... 不少玩家反映!衢州都莱辅助器免费下载!好像确实有开挂辅助挂(有挂教学)-哔哩哔哩1、用户打开应用后不...
教学辅助挂!透视辅助工具!原来... 教学辅助挂!透视辅助工具!原来真的有开挂辅助app(有挂分析)-哔哩哔哩1、透视辅助工具免费辅助多个...
做出回应!仙桃晃晃辅助器!其实... 做出回应!仙桃晃晃辅助器!其实是真的有开挂辅助教程(新版有挂)-哔哩哔哩1、许多玩家不知道仙桃晃晃辅...
值得注意的是!决战卡五星最新辅... 值得注意的是!决战卡五星最新辅助!真是确实有开挂辅助方法(证实有挂)-哔哩哔哩1、值得注意的是!决战...
黑科技攻略!浙江宝宝游戏辅助器... 黑科技攻略!浙江宝宝游戏辅助器是真的嘛!真是真的是有开挂辅助脚本(有挂秘诀)-哔哩哔哩1、打开软件启...
刚刚!余干五十k攻略!切实确实... 刚刚!余干五十k攻略!切实确实有开挂辅助教程(竟然有挂)-哔哩哔哩1、超多福利:超高返利,海量正版游...
2026版攻略!川南九九辅助!... 2026版攻略!川南九九辅助!一直确实有开挂辅助攻略(有挂解密)-哔哩哔哩1)川南九九辅助免费钻石:...
此事迅速冲上热搜!哥哥打大a有... 此事迅速冲上热搜!哥哥打大a有没有辅助!一贯是真的有开挂辅助脚本(有挂秘籍)-哔哩哔哩1、该软件可以...
2026版规律!约局吧透视辅助... 2026版规律!约局吧透视辅助ios下载!一直真的有开挂辅助技巧(今日头条)-哔哩哔哩约局吧透视辅助...
2026版辅助挂!胡乐辅助脚本... 2026版辅助挂!胡乐辅助脚本是真的假的!切实真的是有开挂辅助app(有挂透视)-哔哩哔哩进入游戏-...