Skip to main content

Code Branding

These CodeGen settings allow white-labeling and personalization of SDKs.

Brand Label​

This setting is used to specify the company name that the code generator should associate with your SDK. The brand name provided is utilized within the copyright notice included in every SDK package.

note

If you're creating a fully white-labeled SDK where all attribution to APIMatic should be omitted from the source files, this setting isn't applicable as the attribution information is already removed.

Configuring this option will add the specified brand label to the header of the generated files.

Usage​

To use this feature, you need to specify a String value to be used as a label. 

"info": {
    ...,
    "x-codegen-settings": {
        "BrandLabel": "Tech Corp"
    }
}

Language Support​

C#JavaPHPPythonRubyTSGo
✔️✔️✔️✔️✔️✔️✔️

Change in SDK​

This setting controls the appended message that appears at the start of every file.

Value Change
Default 
<!--
 - PetStore
 -
 - This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
-->
Configured 
<!--
 - PetStore
 -
 - This file was automatically generated for Tech Corp by APIMATIC v3.0 ( https://www.apimatic.io ).
-->

Use this setting to set a copyright notice to prepend to all code files.

note

This setting is only applicable to white labelled SDKs.

Usage​

To use this feature, you need to specify a String value. If no value is provided, APIMatic CodeGen will use the MIT copyright notice instead. 

"info": {
    ...,
    "x-codegen-settings": {
        "ShortCopyrightNotice": "Copyright text here..."
    }
}

Language Support​

C#JavaPHPPythonRubyTSGo
✔️✔️✔️✔️✔️✔️✔️