Skip to main content

October 2024 Release Notes

We are excited to introduce a range of significant improvements to the liblab platform this month! Our team has been focused on native API Documentation integrations (Mintlify & Redocly), extending native OAuth and Pagination to new languages, and giving customers the ability to customize their SDK documentation further. Let's dive in!

New Releases this Month​

  • Pagination was added to the TypeScript v2, Python v2, and Java v2 SDKs, enabling developers to efficiently manage large datasets by retrieving data in smaller, manageable chunks.
  • Native OAuth Support is now available for TypeScript v2, Java v2, and Python v2 SDKs, offering a more integrated and secure method for managing OAuth tokens across all API endpoints.
  • The TypeScript v2 SDK is now generally available (GA), offering enhanced type safety and schema validation powered by Zod. The Java v2 SDK has been updated with built-in validation, pagination support, and added support for complex OpenAPI models, making API integrations more reliable and efficient.
  • API documentation providers such as Mintlify and Redocly are now natively integrated with liblab, allowing developers to automatically update API documentation with SDK code snippets and provide real-world examples for easier API integration.
  • The new Enhanced OpenAPI spec feature allows customers to integrate SDK code samples directly into API documentation and integrate with a wide variety of API Documentation providers. This provides a seamless experience for developers to interact with API endpoints using real-world SDK examples.
  • Readme customization allows developers to override API descriptions in the generated SDK documentation, providing greater flexibility in tailoring documentation to user needs.

Pagination​

We're excited to announce that pagination support has been seamlessly integrated into our TypeScript v2, Python v2, and Java v2 SDKs! This powerful feature simplifies data retrieval and empowers developers to efficiently process large datasets with ease.

Key Features​

  • Enable Pagination: You can configure the pagination feature directly through your OpenAPI spec using the x-liblab-pagination or via liblab.config.json.
  • Offset and Limit Support: Use these parameters to control the amount of data returned in API calls.
  • Effortless Iteration: Iterate through paginated data using a simple for loop or the next() function.
  • Optimized Data Fetching: Avoid overloading your application with large datasets by fetching smaller, manageable chunks.

For developers handling APIs with large datasets, pagination improves performance by controlling the data retrieved in each request, resulting in faster, more efficient applications. Explore Pagination documentation for more details.

Native OAuth Support​

Native OAuth support is now available for the TypeScript v2, Java v2, and Python v2 SDKs. This enhancement simplifies API authentication by providing a more integrated and secure approach to managing OAuth tokens, ensuring seamless permission control across all endpoints.

Key Features​

  • Global OAuth Configuration: Easily configure OAuth for all API endpoints simultaneously, streamlining the authentication process.
  • Endpoint-specific OAuth: Fine-tune OAuth settings for individual endpoints to meet specific security needs.

The native OAuth support makes the SDK security more robust for your API integrations by enforcing permission-based access. You can control which users can access sensitive data and define what actions they can perform, offering a higher level of security and user experience.

To learn how to configure OAuth for your SDK, visit the Authentication Guide.

TypeScript v2 SDK​

liblab has released the TypeScript v2 SDK generator, designed to help developers integrate APIs more efficiently. This new version significantly improves type safety, validation, and code clarity, making integrating with existing TypeScript projects easier.

Key Features​

  • Zod Validation Integration: Includes Zod for schema validation, ensuring secure and reliable data handling.
  • Enhanced Type Safety: Leverages TypeScript's strict typing to minimize runtime errors and enhance code stability.
  • Improved Documentation: Provides Models and Services documentation, making it easier to navigate and integrate the SDK features.

This updated version follows TypeScript best practices and offers a modular, scalable architecture, empowering developers to easily build stable and maintainable applications. For more information and examples, access the detailed tutorial Explore the v2 TypeScript SDK.

Java v2 SDK​

The new Java v2 SDK from liblab offers an easier way for developers to integrate APIs. With enhancements like asynchronous methods, improved validation, and support for complex models, Java developers can now build more robust and scalable applications.

Key Features​

  • Asynchronous Methods: Supports both synchronous and asynchronous methods, with non-blocking functionality via CompletableFuture.
  • Enhanced Code Readability: The new version generates SDKs with cleaner models and improved code clarity.
  • Improved OpenAPI Support: The SDKs are now capable of handling complex models like oneOf, anyOf, and allOf, ensuring compliance with modern API specifications.

These improvements make the Java v2 SDK a powerful tool for developers, ensuring smoother API integrations, improved performance, and easier maintenance of complex API interactions. Explore all new features by accessing the Read the v2 Java SDK Overview tutorial.

API Documentation Providers​

liblab now integrates with popular API documentation platforms like Mintlify and Redocly, automating the process of updating your API documentation when changes are made to your OpenAPI specification. By leveraging liblab’s enhancedApiSpec output, you can enrich your API documentation with SDK code snippets, providing developers with interactive and real-world examples that are always in sync with your API updates.

Key Features​

  • Automated API Documentation Updates: liblab automates the process of keeping your API documentation up to date by enhancing your OpenAPI spec with SDK code snippets and synchying the documentation deployment.
  • Enhanced Developer Experience: SDK snippets embedded directly into the documentation give developers clear, practical examples of interacting with your API, helping the onboarding process.
  • Flexible Integration: With native support for documentation platforms like Redocly and Mintlify, you can easily generate high-quality, interactive API documentation that syncs with your API changes.
  • Code Snippets: SDK examples are automatically added to your documentation based on the supported languages in your liblab configuration, ensuring developers have access to ready-to-use code in multiple languages.

For more details on integrating Redocly with your liblab project, check out the Redocly Integration Guide. You can also access the API documentation providers for additional information.

Enhanced OpenAPI Spec​

liblab’s Enhanced OpenAPI Spec feature embeds SDK code samples directly into your OpenAPI specification, providing real-world examples that help developers understand how to interact with your API using the SDK. These enhancements are applied at the operation level, ensuring your documentation remains in sync with the latest SDK updates. The resulting OpenAPI spec can be used to generate API documentation with a variety of providers, including Mintlify and Redocly, which are natively supported by liblab.

Key Features​

  • SDK Code Samples: Automatically generate code examples for all API endpoints for the programming languages you generate the SDKs.
  • Real-World Scenarios: Developers can see exactly how to use the SDK to interact with API endpoints.
  • Easy Integration: liblab automatically injects code snippets into your OpenAPI spec’s x-codeSamples property when generating the SDK, ensuring your documentation reflects the latest updates.

For more information on how to enhance your OpenAPI spec and integrate it with documentation providers, refer to the Enhanced OpenAPI spec documentation.

Readme customization​

liblab allows you to customize the Readme file generated with your SDKs by overriding the API description from your OpenAPI spec.

Key Features​

  • Custom Descriptions: Now, you can tailor your API descriptions to suit the needs of your users.
  • Flexible Overrides: Easily override the default descriptions directly in your SDK’s Readme file.

For more on customizing your SDK’s Readme file, check out the Readme customization documentation.

These features continue to make liblab a powerful tool for generating SDKs, enhancing API documentation, and improving the overall developer experience. Stay tuned for more updates next month!

Last updated on