Logo
NeoArc Studio

Getting Started with Async APIs

Create your first async event API documentation in NeoArc Studio. Walk through creating an API definition, adding servers, channels, operations, and messages.

This guide walks you through creating async event API documentation from scratch. By the end, you will have a documented API definition with servers, channels, operations, messages, and security schemes.

Step 1: Create an API Definition

Step 2: Add Servers

Step 3: Define Security Schemes

Open the Security section and click Add Security Scheme. Select the scheme type from 13 available options. Configure the scheme-specific properties:

Step 4: Create Channels

Step 5: Create Operations

Operations define whether your application sends (publishes) or receives (subscribes to) messages on a channel.

Step 6: Define Messages

Next Steps