September 2021 Summaries

The OpenAPI Initiative has announced the release of OpenAPI 3.1, which introduces multiple new functionalities and improvements compared to its predecessors. APIMatic, a solution provider for API management, has announced that it supports OpenAPI 3.1 as one of its latest supported API specification formats, enabling users to transform their existing API definitions into OAS 3.1 or generate API portals and SDKs in various programming languages using the APIMatic Code Generator and Docs Generator. The APIMatic Transformer tool maps components from OpenAPI 3.0 to OpenAPI 3.1, including the Schema Object, Info Object, Components Object, Responses, Parameters, RequestBodies, and other components, addressing differences such as nullable flags, exclusive minimum and maximum values, single-valued enums, file uploads, and reference objects. The tool also supports multiple examples and updates in OpenAPI 3.1, allowing users to transform their existing OpenAPI 3.0 files to the latest format with minimal effort using APIMatic's transformation capabilities.

The OpenAPI Specification is a machine-readable format used to describe RESTful APIs, allowing for flexible and efficient communication between clients and servers. It supports defining parameters with attributes such as "required", which indicates whether the parameter must be included in each request, and nullable properties, which allow for null values in JSON serialization. The specification also enables optional properties, where fields may or may not be present in the resultant JSON string during serialization. Four combinations of required and nullable properties can occur: Optional Nullable, where an uninitialized field is ignored; Optional Non-Nullable, where an uninitialized field is not included but a non-null value is handled differently; Required Nullable, where a required attribute always includes its null or non-null value; and Required Non-Nullable, where a required attribute cannot be null. Understanding these combinations is essential for effectively using optional and nullable properties in API requests and client SDKs.

Creating an API-driven solution is no longer sufficient; proper documentation, code samples, and SDKs are essential to ensure a smooth user experience. Building and maintaining an SDK requires careful planning, addressing various challenges such as technology evolution, language ecosystem changes, and business-oriented issues. The cost of building and maintaining a single SDK can be substantial, with estimates ranging from $22,687 to $52,000, depending on the complexity and scope. However, using a code generator like APIMatic can significantly reduce costs and time, automating SDK generation and maintenance while ensuring robustness and reliability.