Page Comparison

...

• The API must be defined in an Open Proxy Specification file (See Open Proxy Specification for details)

  • This file must be located in the top-level directory and must be named
    open-proxy.yaml, open-proxy.yml or open-proxy.json

• Optionally, you may include an Open API file for documentation. Both Version 2 (Swagger) and Version 3 are supported.

  • The Open API file must be located in the top-level directory and must be named
    open-api.yaml, open-api.yml or open-api.json

• Each version of your API must be tagged in Git. API Control Plane will scan the repository for all git tags and will attempt to import the content for each tag as a distinct API version. The version name in API Control Plane will be equal to the Git tag. It is highly recommended, but not required, that the version name inside each Open Proxy Specification file matches the Git tag at which the file is found. Similarily it is recommended that the API name inside all Open Proxy Specification files in a repository is the same.

  • If you differ from any of these conventions, note that when deploying an API to a gateway, only the content of the Open Proxy Specification file is relevant. E.g. if the API name in API Control Plane differs from the one in the Open Proxy Specification file, the API inside the gateway will be named according to the Open Proxy Specification file.

...

When you create an API from a Git repository, you will be asked for a Git credential. If you haven’t already, you must create the Git credential before starting the API creation process. See git Credentials on how to do that.

API Creation Process

• Navigate to “APIs“ in the menu on the left side.

• Select “Create New API“ from the menu in the top right corner.

...

• A dialog will open, that will guide you through the API creation process. Make sure to select “Create new API from git”. Enter the url of your Git repository and select one of your Git credentials.

...

• In the final step, you will see which environments you have selected and you can choose which API version to deploy into these environments. Click “Deploy and Finish“ to start deploying the API and finish the API creation process. If you want to deploy more than one API version, you can do that later as described in Deploying Universal APIs (Open Proxy Specification).

...