A presentation at Longhorn PHP in in Austin, TX, USA by Taylor Barnett
Person dreaming of self documenting APIs
Overview of the section of an OpenAPI document
openapi: 3.0.0 info: version: 1.0.0 title: “Corgi API” (and it goes on…)
components: schemas: Corgi: required: (and it goes on…)
email -> taylor@stoplight.io twitter -> taylor_atx
Bridge with HTTP on it
Bridge with HTTP on it and humans written below
Having an OpenAPI Specification (OAS) is a useful document for numerous reasons. The most common being the ease of generating API reference documentation, but it overshadows some additional benefits that you can gain from adopting the OpenAPI Specification. This talk will delve into the hidden value of the OpenAPI Specification, and how you can employ it to your advantage. Some of the ideas that we will explore are:
– What are the lesser known benefits of using OAS to build API docs – What is a single source of truth in an API – How OAS gives us a way to breakdown APIs and helps us improve communication around HTTP – How design-first APIs, mocking, and testing with OAS can create better developer experiences through feedback cycles – How OAS creates a structured document for collaboration between teams and other ways OAS can increase collaboration throughout the API design process
Attendees will leave the talk having a better grasp of how the OpenAPI Specifications can fit into their workflow, including different PHP and language-neutral tools, and how they can leverage it to improve their API design and developer experience processes.
The following resources were mentioned during the presentation or are useful additional information.
A great place to start to check out different OpenAPI tooling
A flexible JSON linter with out of the box support for OpenAPI v2 and v3
Turn any OpenAPI document into an API server with mocking, transformations, validations, and more.
An introductory talk on API Contract Testing
Here’s what was said about this presentation on social media.
