May PHP Meetup - Describe Your API With OpenAPI

No matter how big or small your API, no matter the audience, internal or external, you need to provide clear and precise documentation so that others know how to use it. Since its inception as Swagger almost ten years ago, OpenAPI has been steadily gaining ground as the de facto specification for describing REST APIs. Whether your API is yet to be built or has been around for a decade, OpenAPI is a tool you can use to document all the parts of your APIs.

In this talk, I’ll introduce you to the basic concepts of OpenAPI, we’ll use it to create documentation for a simple API, and I’ll leave you with a few tips, tricks, and gotchas I’ve learned along the way. You should be able to take what you’ve learned and immediately begin describing your APIs with OpenAPI.

—

Ben Ramsey is a web developer, author, and speaker. He is a software architect at ShootProof, where he builds a platform for professional photographers. He enjoys working on APIs, developing open source software, playing table-top games, and spending time with his family. Ben blogs at benramsey.com and is @ramsey on Twitter.