Welcome to the OpenAPI Governance Templates!

The purpose of this workspace is to illustrate common API patterns as OpenAPI descriptions for easy emulation in your work. Browse APIs to find OpenAPI descriptions showing how to articulate a variety of data formats, operations, patterns, and more in OpenAPI descriptions.

Getting Started

These example templates illustrate everyday tasks often seen within an OpenAPI description. If you're wondering how to articulate versioning via a content-negotiation header in an OpenAPI document, for example, [find the related pattern] copy the appropriate syntax, and be on your way!

Going Further

Using templates to accelerate individual API development is good. What's better is combining templates to provide a canonical template example for the organization. This holistic reference can serve as a jumpstart for any new OpenAPI design. Avoiding guesswork on how to do everyday tasks not only accelerates the design process; starting work from a standard template also increases API consistency across an API ecosystem.

About Qodex Open Technologies

[Qodex Open Technologies] is a team dedicated to improving the practice and application of APIs. It impores specifications, tooling, research, and storytelling across industries and job families.