Add Specifications

Projects support creating API specifications from scratch using a form-based editor. Use this approach when you are designing a new API without an existing Kafka topic to extract from.

The editor provides a structured, form-based interface for defining API details, channels, messages, and schemas without manually writing AsyncAPI specification code.

Tips

If your API is backed by an existing Kafka topic with a registered schema, use Extract Specifications instead to generate the spec automatically.

Create an API Specification

Navigate to Workspaces → [Workspace Name] → [Project Name]
Click the + icon to open the new specification dialog
Enter the specification details:
- Name — A unique identifier for the API specification within the project. Used to reference this spec when creating API Products.
- Description — (Optional) A short summary of the API's purpose and the data it represents.
Optionally link to a live environment:
- Environment — Select an Environment to associate this spec with a running Kafka cluster. Enables validation against live topics.
- Service — Choose the specific Kafka service within the selected environment.
Click Create

The specification opens in the form-based editor.

Working in the Editor

Once created, the editor lets you define the full API structure:

Info — API title, version, description, and contact details.
Channels — Define Kafka topics as publish or subscribe channels.
Messages — Specify message schemas for each channel, including key and value formats.
Servers — Configure Kafka server connection details for different environments.
Components — Define reusable schema definitions, security schemes, and message bindings.

Changes are saved as a new version of the specification. Previous versions remain accessible for comparison and rollback.

Next Steps

Once your specification is ready:

Use Manage APIs to review, version, and update your specifications.
Create an API Product in the API Catalog to publish the spec to consumers.