Many companies begin their journey with OpenAPI definitions by generating documentation. The only requirement to generate API documentation is a valid API definition.
Many companies begin their journey with OpenAPI definitions by generating documentation. The only requirement to generate API documentation is a valid API definition.
When it comes to code generation, there are best practices to ensure the resulting code is easily understood by developers, and you avoid generating invalid code.
In this talk, we’ll review 5 best practices to prepare your specification for use with popular SDK code generators. We’ll also touch on tools you can use in your workflow to build, maintain, and ensure your API definition continues to generate high-quality code over time. Lastly, we'll demonstrate APIMatic's new VS Code extension that can auto-magically fix your API definition, resulting in higher-quality SDKs.
The key topics covered in the video:
------------
[00:00] Intro
[00:26] What is an SDK?
[01:52] Why do developers want SDKs?
[05:54] Benefits of generating SDKs from OpenAPI?
[7:11] Tools to use with your OpenAPI definitions
[08:14] The five pitfalls that you want to avoid when working with OpenAPI and generating SDKs
[16:19] APIMatic for VS Code demo
