October 2023 Summaries

Speakeasy has introduced new features to its SDKs, including support for C# and Unity as generation targets, which expands the capabilities for developers across various platforms and applications. The C# SDK is designed with minimal dependencies, full interface implementation for dependency injection, asynchronous requests, and compatibility with net5.0 for partial Unity support. The Unity SDK offers native UnityWebRequest support, serializable models, streaming downloads, and async/await compatibility, catering to developers from indie to AAA studios. Speakeasy has also enhanced its SDKs with multi-level namespacing and the ability to monkey patch via .genignore, and addressed several improvements and bug fixes in managed SDKs, Terraform providers, and Typescript documentation. Additionally, the API key creation for SDK generation has been moved to the backend to ensure secure and consistent handling across workspaces.

The blog post provides a comprehensive guide to using the keywords oneOf, allOf, and anyOf in OpenAPI 3.X documents, which are based on JSON Schema and crucial for defining complex and flexible data structures within APIs. It explains that oneOf is used to specify scenarios where a property can have multiple possible data structures but only one is valid at a time, functioning similarly to union types in programming. allOf is used for combining multiple schemas into one, akin to intersection types, but can lead to illogical schemas if not handled carefully. anyOf is discussed as the most problematic due to its potential to create a combinatorial explosion of types, leading to unintended behavior in code generation; thus, it is recommended to be avoided unless absolutely necessary. The post also addresses common pitfalls and best practices, such as not using oneOf to denote nullable objects, and highlights the importance of understanding these distinctions to prevent downstream issues in SDK generation.

Speakeasy SDK Sandboxes provide a convenient solution for testing and experimenting with software development kits (SDKs) by allowing both developers and end-users to bypass complex setup processes through a single click in GitHub. This feature alleviates the need for setting up multiple language-specific development environments and managing dependencies, offering a friction-free experience by automatically creating a ready-to-use sandbox environment. The sandboxes come equipped with an in-browser integrated development environment (IDE) and the Speakeasy command-line interface (CLI), which facilitate immediate exploration and usage of SDKs without extensive documentation searches. By integrating with platforms like GitHub's Codespaces, the tool provides seamless support for languages such as Go, Typescript, and Python, and it helps enhance the overall developer experience by enabling users to generate and interact with SDK usage examples efficiently.