REST API Home
Configure API-level settings: servers, security schemes, and metadata
You are editing the REST API home file (rest.api.json). This is the top-level configuration for your API, where you define servers, security schemes, and metadata. Individual endpoints are defined separately in the definitions/ directory.
Sections
Security schemes
Define reusable authentication methods that endpoints can reference:
Learn more
Create complete REST API documentation with NeoArc Studio. Define endpoints, configure security, and export to OpenAPI 3.1 format.
Configure API authentication with HTTP Bearer, API keys, OAuth2, OpenID Connect, and mutual TLS. Set default security and endpoint-specific overrides.
Complete reference for REST API documentation including endpoints, parameters, security schemes, responses, and OpenAPI export.
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 one of six API types (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.