May 2018 Summaries

In 2015, Rebilly faced a challenge when integrating with a larger enterprise that relied on a third-party ERP for integrations, which threatened to delay or even stall the process. To address this, Rebilly adopted an API-Design First approach by co-designing a partner-specific API with the enterprise using a private GitHub repository and a continuous integration system to build ReDoc-rendered API documentation. This collaboration involved iterative adjustments to the API definitions based on feedback from business analysts, ultimately creating a more familiar and necessary API for the partner. The clear documentation and shared understanding accelerated development and integration, leading to a successful and lucrative $22 million enterprise deal. The use of visually appealing API documentation was crucial in engaging non-technical stakeholders and ensuring a professional presentation, demonstrating the effectiveness of the API-First Design methodology.

ReDoc emerged from a need to improve the presentation of OpenAPI definitions in API reference documentation, highlighting the crucial role of developer documentation in shaping the developer experience. Beyond documentation, the API Developer Portal encompasses various aspects of the developer experience, including API design, implementation, uptime, and speed. The creators of ReDoc are committed to enhancing the API Developer Portal and encourage feedback on both positive and negative experiences with developer portals to foster continuous learning and improvement. For further insights, they invite readers to explore their article on Medium about API documentation or to request an invite for more updates.