Home / Companies / Speakeasy / Blog / Post Details
Content Deep Dive

Code as Docs Integration: SDKs embedded in your API reference

Blog post from Speakeasy

Post Details
Company
Date Published
Author
Sagar Batchu
Word Count
365
Language
English
Hacker News Points
-
Summary

A new "code as docs" integration, developed in partnership with Mintlify, aims to simplify production API integrations by embedding SDKs directly into API documentation. This collaboration focuses on enhancing the developer experience by generating code snippets for every method in an OpenAPI specification and incorporating them into the API reference using the x-codeSamples extension. This integration can be activated with a simple workflow configuration change and is compatible with various documentation providers, including Mintlify, Redoc, and Readme. Looking to the future, the initiative plans to evolve these code snippets to become fully executable within a live sandbox environment, further streamlining the process for developers to adopt and implement APIs directly from documentation pages.