Today I read the announcement of OpenAPI (fka Swagger) support in API Gateway on OCI. I was wondering what that entailed and I decided to try it out.
In short, this support means that an API definition can be uploaded to API Gateway, is validated for correctness and can be shared among people accessing the OCI API Gateway definition on OCI. Furthermore, an API Deployment can be created from the imported OpenAPI definition, with routes (of type Stock Response) for the paths in OpenAPI definition. I will demonstrate this in this article.
Robert Wunderlich in his announcement wrote:
Faster prototyping: A stock response API can be automatically created for developers and their consumers to test the APIs ahead of the implementation. A developer can add policy configurations around the stock response for deeper prototyping.
I have not seen this automated creation of the actual stock response content. I am not sure if that is what he means, but that certainly would be nice. The documentation on this specific feature is pretty limited.
So let’s quickly get going, with the simplest of OpenAPI definitions:
I copied and pasted the definition to a file called open-api-3-0-simple.yaml.
Then I opened the OCI Console and went to the API Gateway menu entry.
On this page I clicked on APIs and on Create API Resource. I typed the name simple-api and up0loaded the very simple API definition. Read the complete article here.
For regular information become a member in the Developer Partner Community please register here.