Skip to main content

Importing Your API Specification

If you already have an API specification file in one of the supported formats, you can import it into your dashboard to get started instantly. You can also provide additional settings on how you want to import the API specification file as explained in Configure Import Settings.

note

You need to be signed in from an APIMatic account to follow this tutorial. Signing up is free.

  1. On the APIMatic Dashboard, click on Import API.

    Import API

  2. Either browse and Select API Description File from your local machine or Enter a URL that points to the API specification file. Click on Import.

    Import from Local/URL

  3. Logging Summary is displayed that shows which API specification format is being imported and identifies number of models and endpoints. Click on Proceed.

    Import from Local/URL

  4. Before import, APIMatic performs validation of your API specification. API specification import cannot proceed if the validation fails. You will be required to fix the issues listed for your definition if that happens. Click Proceed to move to the next step.

    API Validation APIMatic


  5. Upon successful validation, your API is imported and displayed as an API entity in the APIMatic Dashboard.

    Imported API Spec APIMatic

  6. You can now create SDKs or generate API portals from this imported API specification.