Get Started with Tyk OAS APIs
Last updated: 2 minutes read.
Introduction
The OpenAPI Specification (OAS) is a ‘vendor neutral’ open standard specification for APIs supported by a large number of tools that will help you design and create APIs for your services. You can even generate them from your source code. Tyk supports you to work with APIs that you’ve designed to the OpenAPI Specification, making it even easier to get your API up and running.
There’s lots of detail on how Tyk works with OAS APIs in the dedicated section in the docs, but here we offer a series of tutorials that will get you up to speed with using this powerful and flexible feature.
We’ll show you how to:
- Create a Tyk OAS API
- Import a Tyk OAS API
- Update a Tyk OAS API
- Extend your Tyk OAS APIs with Tyk Middleware
- Use versioning with Tyk OAS APIs
- Export a Tyk OAS API
Note
Tyk OAS API support is currently in Early Access and some Tyk features are not yet supported. We are working towards parity with the Tyk Classic API so that you will be able to use this exciting new feature for all use cases. You can see the status of what is and isn’t yet supported here.
Schemas
We have a schema that will allow you to use a 3rd party editor and IDEs when creating a Tyk OAS API Definition. It is available from our Tyk Schemas GitHub repo.
Visual Studio Code Extension
We have published a Tyk VS Code extension that provides Tyk API schema validation and auto-completion (both OAS and other schemas) in the VS Code marketplace. You can use it to create Tyk objects in your IDE (Tyk API definitions, Key and Tyk config file).
Community Feedback
We have created an OAS Category in our Community Forum. Please feel free to start conversations in there and we will help you out.