REST API Documentation Reference
Complete reference for REST API documentation including endpoints, parameters, security schemes, responses, and OpenAPI export.
The REST API editor supports complete OpenAPI 3.1 compatible endpoint definitions with full security scheme support, parameter management, and response documentation.
Reference Topics
| Topic | Coverage |
|---|---|
| Endpoints | HTTP methods, paths, tags, request bodies, and operation IDs |
| Parameters | Path, query, header, and cookie parameters with schemas |
| Security Schemes | Bearer tokens, API keys, OAuth2, and OpenID Connect |
| Responses | Status codes, response schemas, headers, and examples |
API Definition Properties
| Property | Type | Description |
|---|---|---|
| id | string | Unique API identifier |
| name | string | Display name for the API |
| description | string | Rich text description |
| version | string | API version (e.g., 1.0.0) |
| securitySchemes | array | Security scheme definitions |
| servers | array | Server configurations |
| endpoints | array | Endpoint definitions |
| tags | array | Global tags for organisation |
Server Configuration
| Property | Description |
|---|---|
| id | Server identifier (e.g., prod, staging, dev) |
| url | Base URL for API requests |
| description | Server purpose and environment |
Key Features
Document REST APIs with full endpoint specifications, OpenAPI import and export, seven HTTP methods, parameters, request and response bodies linked to shared schemas, authentication schemes, and a published API browser. REST is part of the API documentation suite (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.
Step-by-step guide to creating REST API documentation with endpoints, parameters, schemas, and security in NeoArc Studio.