Each API must be defined in the OpenAPI Specification (OAS) version 3.
The API specification must be created in SwaggerHub.
Currently, SWIFT uses the Cloud version of SwaggerHub, but in the future an On-Premises version of SwaggerHub will be available.
Once the API specification is published in SwaggerHub, it must be made available on the SWIFT Developer Portal.
The OAS document describes all resources and their associated operations (CRUD).
The OpenAPI Specification version 3 is defined in GitHub.
Convention: Each API must be defined in the OpenAPI Specification version 3.
| Internal | Private | Partner | Open |
|---|---|---|---|
| Could | Should | Must | Must |
Convention: Each API specification must be created in SwaggerHub.
| Internal | Private | Partner | Open |
|---|---|---|---|
| Could | Should | Must | Must |
Convention: Each published API must be made available in the SWIFT Developer Portal.
| Internal | Private | Partner | Open |
|---|---|---|---|
| Could | Should | Must | Must |