不需要启动完整的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、拱趴大菠萝挂哪里ai机器人多...
透视存在!如何下载德普之星辅助... 透视存在!如何下载德普之星辅助软件,(德普)切实是有挂,新版2025教程(有挂插件)亲,关键说明,如...
透视黑科技“pokerworl... 透视黑科技“pokerworld破解版下载”透视辅助器(总是是有挂);暗藏猫腻,小编详细说明poke...
透视挂透视!德普辅助器辅助器怎... 透视挂透视!德普辅助器辅助器怎么用,(德普)本来有挂,科技教程(有挂揭秘)1、德普辅助器辅助器怎么用...
透视黑科技“werplan怎么... 透视黑科技“werplan怎么作弊”透视辅助助手(竟然真的是有挂)1、在werplan怎么作弊ai机...
透视好友房!德普之星透视辅助软... 透视好友房!德普之星透视辅助软件激活码,德普之星怎么设置埋牌,插件教程(有挂方法)1、下载好德普之星...
透视规律!约局吧怎么看有没有挂... 透视规律!约局吧怎么看有没有挂,uupoker有透视吗,攻略方法(有挂解说)1、约局吧怎么看有没有挂...
透视黑科技!德普之星透视辅助软... 透视黑科技!德普之星透视辅助软件激活码,(德普)果然真的有挂,攻略教程(有挂技巧)1、下载好德普之星...
透视苹果版“约局吧如何查看是否... 透视苹果版“约局吧如何查看是否有挂”透视辅助app(切实有挂)1、约局吧如何查看是否有挂系统规律教程...
透视线上!德扑之心免费透视,德... 透视线上!德扑之心免费透视,德普之星有透视辅助吗,透明挂教程(有挂揭秘);1、任何德普之星有透视辅助...