Now you can upload a ZIP file containing your Postman Collection file along with any Postman Environment Files. That way we will extract values for your environment variables from the Environment files and give a better output during conversions on the Transformer or when importing APIs to your Manage APIs page. Support for Postman data dump files has now been added as well.
Model Classes Code Improved
We've made an improvement to how model properties are now generated in the code. The generated SDK now contains both camel case-d version of the property name and the actual property name (where applicable).
Read on to find more details about the change.
Please generate your SDK again to get the improved code.
ES6 Promises in NodeJS
NodeJS SDKs will now return promises in endpoint calls, as an alternative to accepting callbacks.
- We use ES6 Promises which is based on Promises/A+ and is interoperable with most Promise-based implementations.
- Callbacks are still supported (for backward-compatibility) but are now optional.
Re-generate your NodeJS SDK to get the new Promise-enabled SDK implementation now.
Additional Model Properties Support in Node SDK
NodeJS SDKs can now optionally preserve additional properties returned in the response. This setting can be enabled via Settings > CodeGen Settings
page in the API editor and turning on the Enable Additional Model Properties
flag.
Node.js Circular Dependency Fix
We have changed the structure of the SDK to break cyclic dependencies. Due to this, the following changes have been made:
- Model deserialization logic has moved out from model classes.
- We have added new files
ObjectMapper.js
andModelFactory.js
to the sdk. - Exception handling in
BaseController
has changed to useObjectMapper
. BaseModel
is now being used to assign values to model properties (when model class is directly instantiated)BaseController
is not being exposed by the API Client now.
Please generate your SDK again to get the improved code.
Polymorphic Responses with Discriminator Field
APIMatic Code Generation engine now supports polymorphic responses with the help of a discriminator field.
- Discriminator is a field that is used to differentiate between a parent model and models that inherit from it.
- The response is deserialized into the parent model or one of its child classes by inspecting the discriminator field's value in the response.
- Using a discriminator field, you can build leaner models by not having to build unions of fields needed by a polymorphic response.
Check out the Discriminator documentation to get started.
Adopting AirBnb JS Style Guide and ES6 Primitives
Keeping with our tradition of Continuous Improvement, we are proud to announce a major revamp of NodeJS SDKs!
- Our code now conforms with Airbnb's JavaScript Style Guide.
- We are using ES6 classes, along with other ES6 primitives.
- You can run
npm run lint
to lint your code immediately. - We generate CI/CD files for Travis, CircleCi, Appveyor and Jenkins to run NodeJS tests.
Please generate your SDK again if you want the improved ES6 based code.
Optional Model Field Deserialization Issue
There was an issue in code generation for PHP SDKs where the model classes (custom types) had fields with incorrect
PHP typehints. This lead to the JsonMapper
mapping responses incorrectly to models during deserialization. However, this
only occurred when a model had fields that were described as optional in the API description and no default value was provided.
Re-generate your PHP SDK to get the fix.
Added Support for Swagger 1.2 ZIP Files
If you have a Swagger 1.2 API description file split into Resource Listing and API Declaration files, you can import/convert it using a ZIP file. Previously, such API description file could only be converted/imported by providing the Resource Listing file via a URL where all API Declaration files were located relative to this URL.
Array Serialization Formats
Multiple formats are now supported for Array serialisation in form and query parameters. Formats supported include UnIndexed
, Indexed
, Plain
, CSV
, PSV
, TSV
.
This settings can be set using our API Blueprint CodeGen setting extension named ARRAYSERIALIZATION
.