Your API is language agnostic, but your API consumers are not. When Developers Integrate with an API, they do so in their favourite programming language. With the help of an API specification, you can automatically generate up to 90% of the integration code (as SDKs and Code Samples) and save them heaps of time. The problem is, OpenAPI and other API specification formats are not built with code generation requirements in mind, thus we often see Code Generators creating unusable code for syntactically correct API specifications.
This talk will demonstrate how you can carefully craft an API specification to generate production-quality SDKs and API portals. It will help you understand how trivial issues like inline anonymous schemas and naming conventions can have a big impact on the generated output. And how the right kind of validation and linting process can help you overcome all of these issues efficiently in order to help you build a world-class Developer Experience.
2. Which Machine Readable API Definition
Format Do You Use?
2
OpenAPI?
RAML?
Postman?
Insomnia?
API Blueprint, WADL, WSDL, IODocs, HAR, Google
Discovery?
56. 56
Thanks!
Any questions?
You can find me: adeel@apimatic.io
Resources:
Validator: apimatic.io/solution/fix-my-spec
API Trends: apimatic.io/blog
NASA API: apimatic.io/blog/2021/12/million-mile-views-via-a-nasa-api
SDK Advantage Book: apimatic.io/resource/modern-guide-to-building-sdks
57. Credits
Special thanks to all the people who made and
released these awesome resources for free:
Presentation template by SlidesCarnival
Photographs by Unsplash
57