DEVELOPERLESS API PORTAL

APIMATIC APIs

IN THIS ARTICLE

SHARE THIS ARTICLE

Swagger CodeGen Extensions

Swagger 2.0 facilitates third-party vendors to implement tool specific extensions. These extensions allow customizing behaviors beyond simple API descriptions. We at APIMATIC also offer extensions which are specific to Code Generation and can be specified within your Swagger API description file. These extensions allow you to customize the APIMATIC code generation engine as per your requirements. The following documentation discusses the extensions available and how to use them.

Code Generation Settings and Swagger Extensions

Apparently when importing an API, the code generation settings appears to be non-customizable unless configured manually, after the import, through our UI editor. In case of Swagger, however, we provide extensions that you can use within your Swagger API to specify the said settings and get the desired customizability. We also provide a similar extension for API Blueprint whose details can be viewed at API Blueprint Extensions. The extensions are supported by both the “Import” API operation, as well as by our Code Generation as a Service API.

CodeGen Extensions and How To Use Them

We offer four CodeGen extensions which include the following:

CodeGen Settings

Advanced Settings

Additional Headers

Discriminator Value Extension

CodeGen Settings

APIMATIC offers numerous settings that enables you to configure generic code styling, endpoint settings, model settings, continuous integration settings, code branding options, etc at the time of generating code. More details of these can be viewed at Code Generation Settings.

In order to specify these settings you will need to use the CodeGen Settings extension. Using this extension simply involves using a property x-codegen-settings within the “Info” object. The “Info” object is used in Swagger for providing metadata about the API. Details of this object can be viewed at Swagger Info Object. The x-codegen-settings property is an object that will look something like this:

When true, configuration values e.g., authentication credentials, are expected in app-info.plist file for the iOS SDK. When set, this setting ignores useConstructorsForConfig flag.

iOSGenerateCoreData

Boolean

When true, iOS CoreData schema and classes are generated.

androidUseAppManifest

Boolean

When true, configuration values e.g., authentication credentials, are expected in AndroidManifest.xml file for the Android SDK. When set, this setting ignores useConstructorsForConfig flag.

collectParameters

Boolean

When true, operation parameters are expected to passed as a collection. For example in PHP, the generated method expects a Map containing parameters as Key-Value pairs. This is currently implemented for PHP, Python, GO, and Objective-C. When set, this is applied globally on all endpoints/operations. If you wish to use this option on specific endpoints, use the x-operation-settings::collectParameters instead.

csharpDefaultNamespace

String

A valid C# namespace value to be used as the default namespace. Leave empty or null to automatically generate.

javaDefaultPackageName

String

A valid Java package name to be used as the base package name. Leave empty or null to automatically generate. This value is applied for both Java and Android code generation templates.

enablePHPComposerVersionString

Boolean

When true, adds version component to composer.json file in PHP SDKs. This can cause conflicts with Git tag-based version publishing and should be used with care.

phpComposerPackageName

String

This will set the name in composer.json file for PHP SDKs. You must provide a string with the format your-vendor-name/package-name.

A string value to brand the generated files. For example: “Acme Corp.”

userAgent

String

A string value to use as user-agent in the API calls. This is useful for analytics and tracking purposes. For example: “SDK V1.1”

enableAdditionalModelProperties

Boolean

When true, additional or unknown properties in the response JSON are collected into a dictionary.

nullify404

Boolean

When true, null response will be returned on the HTTP status code 404

useCommonSDKLibrary

Boolean

When true, a common library comprising of common classes is used by the generated SDKs

projectName

String

The name of the project for the Generated SDKs

preserveParameterOrder

Boolean

When true, parameter order is tried to be preserved in endpoints and models

generateInterfaces

Boolean

When true, interfaces for controller classes are generated in the generated SDKs

validateRequiredParameters

Boolean

When true, required API endpoint parameters are validated to be not null

timeout

Float

When true the requests will timeout after the specified duration

Advanced Settings

APIMATIC allows further customization of endpoints (called operations in Swagger) through the Advanced Settings extension. These settings can be specified inside an “operation” object Swagger Operation Object using property name x-operation-settings. See an example as following:

Details of the properties available within this extension are given below:

Property

Type

Purpose

collectParameters

Boolean

When true, this operation’s parameters are expected to passed as a collection. For example in PHP, the generated method expects a Map containing parameters as Key-Value pairs. This is currently implemented for PHP, Python, GO, and Objective-C.

useModelPostfix

Boolean

When true, a postfix “Model” is appended to all classes generated from schemas.

allowDynamicQueryParameters

Boolean

When true, the generated method has an additional Map input, which may contain dynamic number of query parameters as Key-Value pairs.

allowDynamicFormParameters

Boolean

When true, the generated method has an additional Map input, which may contain dynamic number of form parameters as Key-Value pairs.

isMultiContentStreaming

Boolean

When true, it indicates that this operation is a streaming endpoints. For example Twitter Streaming API endpoints.

parameterCollectionName

String

Represents the name of the model that represents CollectedParameters

Additional Headers:

APIMATIC allows defining global headers that are sent with every API call using the Addition Headers extension. These headers are in addition to any headers required for authentication or defined as parameters. These headers can be specified inside a “Security Scheme” object Security Scheme Object using property name x-additional-headers. See an example below:

Details of the properties available within this extension are given below:

Property

Type

Purpose

name

String

Name of the header

description

String

Any details regarding the header

default

String

Any default value for the header

Discriminator Value Extension

Swagger makes use of a property discriminator to support polymorphism in custom types. As per Swagger, the value of this property must be the name of the parent model or the children models depending on which type the object represents. However, we allow our users to specify a custom discriminator value using the APIMATIC’s Discriminator Value extension. This value will override the default custom type name.

Usage

The extension is used through the x-discriminator-value property.

Property

Type

Purpose

x-discriminator-value

String

Custom discriminator value

In case of Swagger 1.2, you can use this extension inside a Model Object as follows: