How to tell springdoc-openapi-maven-plugin to generate YAML instead of JSON?

Question

I am using the springdoc-maven-openapi-plugin this way:

        <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>

This results in an OpenAPI doc in the target folder with a name having a suffix ".yml" but in fact it is a JSON.

How can I tell the plugin to effectively create the doc in YAML format?

score 4 · Accepted Answer · answered Aug 20 '21 at 14:37

4

http://localhost:9090/v3/api-docs is the default api-url, which generates JSON. To create YAML just use http://localhost:9090/v3/api-docs.YAML

answered Aug 20 '21 at 14:37

Thilo Schwarz

640
5
24

OMG. That was too easy, wasn't it? LOL – du-it Aug 22 '21 at 22:03
Yes it was. I had the same problem weeks ago and was searching for hours ... I'll never forget it. :-) – Thilo Schwarz Aug 23 '21 at 07:32

score 3 · Answer 2 · answered Nov 15 '21 at 11:34

The question is about compile-time generation.

For compile it will be like:

<configuration>
    <apiDocsUrl>http://localhost:8080/v3/api-docs.yaml</apiDocsUrl>
    <outputFileName>openapi.yaml</outputFileName>
    <skip>false</skip>
</configuration>

apiDocsUrl should ends with .yaml otherwise it generates JSON in yaml file

Expect by running:

./mvnw springdoc-openapi:generate

In ./target/openapi.yaml the spec in yaml format

See https://github.com/springdoc/springdoc-openapi-maven-plugin/issues/12 for more

How to tell springdoc-openapi-maven-plugin to generate YAML instead of JSON?

2 Answers2

Linked