Getting Started with API Documentation
Create complete REST API documentation with NeoArc Studio. Define endpoints, configure security, and export to OpenAPI 3.1 format.
The REST API documentation tooling supports OpenAPI 3.1 compatible endpoint definitions. Document your APIs with full security scheme support, parameter management, and response documentation, all through a visual editor.
Why Document APIs in NeoArc
Creating an API Definition
API Definition Properties
Every API definition has these core properties:
Server Configuration
Configure server URLs for different environments. Each server has:
Global Tags
Tags organise endpoints into logical groups. Define tags at the API level and apply them to individual endpoints. Common tag examples:
Default Security
Set default security requirements that apply to all endpoints unless overridden. This saves repetition when most endpoints share the same authentication method.
Editor Interface
The REST API editor provides:
Example APIs
Explore these working example APIs that demonstrate REST API documentation with schema integration, security schemes, and full endpoint definitions:
Library API Examples
E-Commerce API Examples
Create a new order with items. Validates product availability and calculates totals.
Healthcare API Examples
Supported HTTP Methods
Content Types
NeoArc supports 36+ content types for requests and responses: