首页 > 解决方案 > 如何告诉 springdoc-openapi-maven-plugin 生成 YAML 而不是 JSON?

问题描述

我正在使用springdoc-maven-openapi-plugin这种方式:

        <plugin>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-maven-plugin</artifactId>
            <version>1.1</version>
            <executions>
                <execution>
                    <id>integration-test</id>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <apiDocsUrl>http://localhost:9090/v3/api-docs</apiDocsUrl>
                <outputDir>${project.build.directory}/my_open_api_specification/</outputDir>
                <outputFileName>my_open_api_specification.yml</outputFileName>
                <skip>false</skip>
            </configuration>
        </plugin>

这会在目标文件夹中生成一个 OpenAPI 文档,其名称具有后缀“ .yml ”,但实际上它是一个 JSON。

如何告诉插件有效地创建 YAML 格式的文档?

标签: jsonspring-bootyamlspringdoc-openapi-maven-plugin

解决方案


http://localhost:9090/v3/api-docs 是默认的 api-url,它会生成 JSON。要创建 YAML,只需使用 http://localhost:9090/v3/api-docs.YAML


推荐阅读