怎么获取swagger.json

想要获取swagger.json文件，首先需要了解Swagger是什么以及它的作用，Swagger是一款流行的API开发工具，可以帮助开发者设计、构建、文档化和测试RESTful API，swagger.json是Swagger用来描述API的一个JSON文件，它包含了API的基本信息、路径、操作、参数等，下面我将详细介绍如何获取swagger.json文件。

通过Swagger UI获取

如果你的项目中已经集成了Swagger，那么获取swagger.json文件就非常简单了，通常情况下，Swagger UI会提供一个默认的访问地址，http://localhost:8080/swagger-ui.html，在这个页面中，你可以看到API的详细信息，以下是具体步骤：

1、访问Swagger UI页面：在浏览器中输入Swagger UI的访问地址，进入页面。

2、查找swagger.json：在页面的“资源”列表中，找到对应的API资源，点击该资源，页面会展示该API的详细信息。

3、获取swagger.json：在浏览器地址栏中，将URL中的/swagger-ui.html更改为/v2/api-docs，回车后，浏览器会显示swagger.json的内容，你可以直接复制页面内容，或者右键点击页面，选择“另存为”将文件保存到本地。

通过代码生成swagger.json

如果你的项目中没有集成Swagger UI，但已经使用了Swagger注解，那么可以通过编写代码来生成swagger.json文件，以下是具体的步骤：

怎么获取swagger.json

1、添加依赖：在项目的pom.xml文件中，添加Swagger相关依赖。

2、编写配置类：创建一个配置类，用于配置Swagger。

Java

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("API描述")
                .version("1.0")
                .build();
    }
}

怎么获取swagger.json

3、生成swagger.json：编写一个测试类，使用Swagger的Swagger2MarkupConverter类来生成swagger.json文件。

Java

public class SwaggerJsonTest {
    @Test
    public void generateSwaggerJson() throws IOException {
        // 获取Docket
        Docket docket = new SwaggerConfig().createRestApi();
        // 生成swagger.json
        String json = new Swagger2MarkupConverter(docket).toJson();
        // 写入文件
        File file = new File("swagger.json");
        FileUtils.writeStringToFile(file, json, StandardCharsets.UTF_8);
    }
}