Create an API Using the Design First Approach

Overview

You can create an API using one of four ways:
  • By uploading an Open API Specification file (Design First)
  • By entering a URL that points to an Open API Specification file (Design First)
  • By creating an API from an existing project
  • By starting with an empty API

This topic shows how to create an API using the Design First approach by providing an Open API Specification (OAS) 2.0 or 3.0 file.

  • Your API specifications must be based on Open API Specification (OAS) 2.0.
  • You must have Write permissions to create an API.
  1. In SnapLogic Manager, go to API Management > API Manager > APIs & Proxies.

    APIs and Proxies tab in the API Manager

  2. Click the add icon ( ) and choose New API.

    New API or New Proxy dropdown

  3. In Create New API, choose the source of the OAS file.
    • Upload File. You must click Choose File to specify the location of the specification file to upload.

      Upload File option

    • Enter URL. You must enter a valid URL pointing to the location of the specification file.

      Enter URL option

  4. In Create New API - Options, select your API Import Configurations.

    Create New API - Options dialog

    Field Description
    Create Specification If selected, the imported specification is included as a File Asset in the API.
    Create Endpoints from Path If selected, endpoints for the new API are created based on its path.
  5. Click Import and Continue.
  6. In Create New API - Details, fill in the details for the new API.

    Create New API - Details dialog

    Field Description
    General Info
    Name (Title) The name of the new API.
    The name must meet the following requirements:
    • Must be unique.
    • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
    • Cannot contain the reserved keyword shared.
    • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
    • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.
    Description A description of the new API.
    Version The version number for the first version of the API.

    Default: 1.0

    Learn more: Managing Versions of Your APIs
    Tags Tags to associate with the new API. You can create the tags as required.
    Endpoint Configuration
    Path to Endpoint (Read-only) The base path for the endpoint.
    Server Configuration
    Snaplex The Snaplex to associate with the new API.
  7. Click Create.