August 2022 Summaries

The announcement introduces a new SDK generator that addresses limitations of the OpenAPI generator by producing typed and opinionated client libraries, emphasizing the importance of SDKs in enhancing developer experience. This newly launched generator is designed to create low-dependency, idiomatic TypeScript code by wrapping axios, ensuring isomorphic compatibility for browsers and Node.js servers while adhering to the OpenAPI specification. It automatically generates typed structures, constructs path variables, and handles query parameters with strictly typed input and output body types. The developers have made considered decisions on aspects like pagination, retries, and authentication to optimize SDK functionality. Highlighting the value of language-idiomatic SDKs in simplifying the integration process for developers, the announcement underscores how they facilitate faster adoption, reduce troubleshooting, and improve overall developer experience. The team is seeking community feedback on the service and is open to suggestions on additional features and language support.

Speakeasy has introduced new features to enhance integration with existing platforms by allowing the addition of React embeds, demonstrated by team member Alexa who also showcases setting up filtering for these embeds. The platform has implemented smaller updates including the ability for customers using the Typescript SDK to mask sensitive data, preventing it from entering the platform, and added support for storing API logs in BigQuery for users self-hosting on Google Cloud Platform. These updates aim to increase flexibility and data security for users of the Speakeasy platform.

The blog post discusses new features in the Speakeasy SDKs, focusing on sensitive data masking and customer-specific API logging views. It highlights how developers can use the middleware controller to prevent sensitive fields, such as request/response fields, headers, or cookies, from entering the platform by masking them or ignoring entire routes. The SDK also allows for the configuration of a customer-specific view by using a customer key, which facilitates filtering API logs down to a single customer. Additionally, the post mentions the ease of service discovery within the Speakeasy platform through the search of APIs registered with associated metadata, such as team or version labels.

Hiring a founding engineering team for a startup can be challenging, as traditional technical assessments often fail to capture essential qualities like comfort with ambiguity, strong product instincts, and a sense of ownership. Speakeasy, after experiencing difficulties with conventional hiring methods, adopted a week-long trial period for candidates, allowing them to work as full team members while being compensated for their time. This approach provided deeper insights into candidates' abilities to contribute meaningfully and align with the company's values and culture. Inspired by Benjamin Bloom's "2 Sigma Problem," which highlights the efficacy of personalized attention, Speakeasy emphasizes transparency and engagement during the hiring process, ensuring that candidates have the opportunity to demonstrate ownership and thoughtfulness. As the company grows, it plans to scale this approach by integrating its core values into new processes while maintaining a focus on a candidate-centered experience, moving beyond standard coding interviews to foster genuine contributions and collaboration.

The Speakeasy SDK has introduced a feature that monitors API traffic against the uploaded OpenAPI schema to detect any discrepancies, known as drift, between the API and its documentation. When such drift is identified, teams can compare schemas to pinpoint where the inconsistencies have occurred. To facilitate real-time awareness and response, Speakeasy can push events to a webhook, allowing integration with team tools to create automatic alerts, such as Slack notifications, whenever an unknown endpoint is detected. Additionally, the Speakeasy SDK has expanded its compatibility to include APIs written in TypeScript, enhancing its utility for developers using this language.

API platforms play a crucial role in transforming API development into a repeatable and consistent process, essential for providing a seamless experience for both internal and external developers. By handling all non-business logic aspects of API operations, these platforms allow developers to focus on core functionalities, ensuring uniformity across APIs in terms of style, error handling, and documentation. Roopak Venkatakrishnan, a director of engineering at Bolt, emphasizes the necessity of formalizing an API strategy early to avoid technical debt and maintain consistency as the company scales. He highlights the importance of both APIs and webhooks, with webhooks serving as a push mechanism to notify customers of system changes. The API platform team at Bolt, known as the DevEx team, focuses on enhancing developer experience by improving API documentation, managing API lifecycle elements like key rotation and authentication, and ensuring that new APIs align with established standards. The team is also working on reducing the time it takes for partner developers to make their first successful API call, while also contemplating the integration of internal APIs into their remit as the company grows.

The RESTful API template project announced by Tristan Cartledge aims to simplify the process of building RESTful APIs, particularly for developers who may find it challenging. The project, which begins with a template for Go, provides a foundational structure to build APIs, encapsulating best practices for a basic REST service. This template includes a CRUD API for a 'user' resource, emphasizing an entity-based approach, proper abstraction of transport, service, and data layers, consistent responses, and thorough testing with unit and integration tests. Additionally, the template offers Postman collections to facilitate endpoint exploration. The project reflects the team's opinion on effective RESTful API design and invites feedback from the developer community for potential enhancements, including features such as versioning, pagination, and authentication.