Are there any generators that support OpenAPI 3?

swagger openapi openapi-generator
MattC picture MattC · Sep 19, 2017 · Viewed 7.8k times · Source

At the time of writing this the OpenAPI 3 spec is relatively new. I am struggling to find any documentation generators that support version 3.0.

Does anyone know of generators that support OpenAPI v3.0?

Answer

William Cheng picture William Cheng · Jun 5, 2018

You can try OpenAPI Generator (https://openapi-generator.tech), which supports both OpenAPI spec v2, v3 and released a stable version (3.0.0) a few days ago.

Using docker, you can easily generate the API documentation:

docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
    -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
    -g html2 \
    -o /local/out/html2

Related questions

Swagger Codegen (with maven plugin) for OpenAPI 3.0

I want to use Swagger Codegen for OpenAPI 3.0 YAML file. And I see Swagger Codegen 3.0.0-rc0 is available. But when I try to use that I run into issues. Following are the details: My pom.xml file with swagger-codegen plugin: &…

Read More
How to describe this POST JSON request body in OpenAPI (Swagger)?

I have a POST request that uses the following JSON request body. How can I describe this request body using OpenAPI (Swagger)? { "testapi":{ "testapiContext":{ "messageId":"kkkk8", "messageDateTime":"2014-08-17T14:07:30+0530" }, "testapiBody":{ "cameraServiceRq":{ "osType":"android", "deviceType":"samsung555" } } } } So far I tried …

Read More
How to define an enum in OpenAPI (Swagger)?

Does anyone know how to define possible 'enum' values in an OpenAPI 2.0 definition so that they will be displayed in the Model tab of Swagger UI? Example here: https://petstore.swagger.io/#!/pet/addPet has an enum option for the …

Read More