Skip to content
|
github-edit-pageEdit this page
report-issueReport an issue

APIs

An API is the interface that you publish to your end customer. Developers register applications for use with specific APIs.

As an API Producer, you publish an OpenAPI specification and additional documentation to help users get started with your API.

This is documentation for Konnect’s new Dev Portal BETA. Be aware of potential instability compared to our classic Dev Portal

Validation

All API specification files are validated during upload. Specs much be valid JSON or YAML, and must be valid according to OpenAPI 3.x spec. This ensures accurate generation of spec documentation.

From Zero to API

Publishing an API is a multi-step process:

  1. Create a new API, including the API version.
  2. Upload an OpenAPI specification for the API and/or additional markdown documentation for your API (either API spec or docs must be provided to generate documentation)
  3. Link your API to a Gateway Service
  4. Publish your API to a Portal

Your API is now published in the Portal that you selected. If User Authentication is enabled, Developers can register to create applications, generate credentials and use the API in a self-service manner.

If you have RBAC enabled, you will need to add an approved Developer to a Team in order to provide access.