Skip to content

Convert Openapi 3 to Swagger 2, using other else work and docker.

Notifications You must be signed in to change notification settings

juanlb/openapi2swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

openapi2swagger

logo

Amazon AWS API Gateway claims that is compatible with Swagger. I don't think so, just the Swagger format version 2 it is supported.

Swagger 2 evolved to Openapi 3, and fame and fortune is all for him.

But the poor souls that want to use the (almost) amazing API Gateway have to wait that Amazon guys include the new format.

Until that happen, I'm glad to anounce:

Openapi 3 downgrade to Swagger 2

I really didn't do anything, I've just combined the great work of other people, in particular: LucyBot-Inc/api-spec-converter

Usage

This repo has a Dockerfile that create a container with the hability of convert a Openapi3 spec file and convert it in a Swagger2 file, compatible with AWS API Gateway.

It works directly out of the box.

Command Line

docker build -t openapi2swagger:latest .
docker run -v /directory/where/is/the/file:/tmp -e OPENAPI_FILE=the_openapi3_file.json  openapi2swagger:latest > ~/swagger2_file.json

Parameters

  • /directory/where/is/the/file : the directory on your computer where is the Openapi3 file spec.
  • the_openapi3_file.json : the file name.

Notes

Removing the "example" property

I don't know yet why API Gateway doesn't support this property in the Swagger spec. The command inside the docker removes those lines with a bash sed command.

Any clue is welcome.

About

Convert Openapi 3 to Swagger 2, using other else work and docker.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published