Metadata

You can now import/convert your API description along with a metadata file that will allow you to configure Code Generation Settings for your API, override authentication settings or control parsing of some components. Details on how to provide this file and its format are provided below.

Applicability

You can provide this file along with your API description during import on the My APIs page or when converting APIs on the Transformer.

Metadata File

The metadata file must be a valid JSON file and the file name MUST start with “APIMATIC-META”.

How to Provide the Metadata File

The API description must be provided in the form of a ZIP file that contains both the API description and this metadata file. Within the ZIP file, the metadata file must exist at the same level as that of the API description. It should not be nested at a different level.

Advantages

1. When importing an API through the My APIs page, this file enables you to configure Code Generation settings for your API. This is useful when you are importing from a format other than APIMATIC that do not have support for specifying additional parameters useful only to SDK generation in APIMATIC.

2. You can override the default authentication settings of your API with those specified in the file.

3. Helps you import various components of an API description file in accordance with any rules specified in the settings.

File Format

The metafile can consist of various JSON objects that will help specify this information. These objects are described in the sections below.

Authentication

The details on the authentication options available in APIMATIC are described here API Authentication. To enable these options via the metafile, you need to specify the authentication object that has the following properties:

Authentication Object

Name: Authentication

Example:

{
  "Authentication": {
    "Type": "Basic",    
    "Parameters": [
      {
        "Name": "username",
        "Description": "your username"
      },
      {
        "Name": "key",
        "Description": "your api key"
      }
    ]
  }
}

Parameter Object

Example:

  {
    "Name": "apikey",
    "Description": "An API key is required for authentication"
  }

Code Generation Settings

The details on the available code generation settings is available at Code Generation Settings . These can be specified in the form of an object as described below:

Code Generation Object

Name : CodeGenSettings

The available properties and their respective types are as follows:

Example:

{
  "CodeGenSettings": {
    "SynchronyMode": 0,
    "ModelSerializationScheme": "Json",
    "ArraySerialization": "Indexed",
    "Nullify404": true,
    "UseHttpMethodPrefix": true,
    "UseModelPrefix": true,
    "UseExceptionPrefix": true,
    "UseEnumPrefix": true,
    "UseControllerPrefix": true,
    "UseConstructorsForConfig": true,
    "Timeout": 0.1,
    "AndroidUseAppManifest": true,
    "iOSUseAppInfoPlist": true,
    "iOSGenerateCoreData": true,
    "CollapseParamsToArray": true,
    "RunscopeEnabled": true,
    "RunscopeBucket": "key",
    "AndroidHttpClient": "UNIREST",
    "ObjCHttpClient": "UNIREST",
    "CSharpHttpClient": "UNIREST",
    "CSharpNamespace": "Root",
    "JavaPackageName": "Root",
    "JavaUsePropertiesConfig": false,
    "PHPHttpClient": "UNIREST",
    "BrandLabel": "Label",
    "UserAgent": "User",
    "ProjectName": "Calculator",
    "EnableAdditionalModelProperties": true,
    "PreserveParameterOrder": true,
    "ValidateRequiredParameters": true,
    "AppendContentHeaders": true,
    "GenerateInterfaces": true,
    "UseCommonSDKLibrary": true,
    "ParameterArrayFormat": 2,
    "GenerateTravisConfig": true,
    "GenerateCircleConfig": true,
    "GenerateAppveyorConfig": true,
    "GenerateJenkinsConfig": true,
    "EnableLogging": false,
    "EnableHttpCache": false,
    "EnablePHPComposerVersionString": false
  }
}

Import Settings

These settings allows you to configure the import through various options e.g. settings that lets you override names of components, etc.

Import Settings Object

The available properties and their respective types are as follows:

Example:

{
    "ImportSettings": {
        "PreferJsonSchemaNameOverTitle": true,
        "AppendParentNameForClashes": true,
        "AutoGenerateTestCases": true
    }
}

Export Settings

These settings lets you configure export to various formats e.g. enabling/disabling extensions when exporting to Swagger.

Export Settings Object

The available properties and their respective types are as follows:

Example:

{
    "ExportSettings": {
        "ExportExtensions": true,
        "GenerateModelSamples": true
    }
}

Have questions? Submit a request.