API Documentation
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.
NeoArc Studio keeps API documentation with your other architecture content. Define endpoints once, reference them in design documents, embed them in architecture pages. Everything stays synchronised because it all lives in the same Git repository.
Endpoint Definitions
Document every aspect of your REST endpoints:
Request and Response Bodies
Request and response definitions go beyond simple JSON examples. Each body specifies a default content type, a list of supported content types, and links to a shared schema definition.
Authentication
Specify authentication requirements for each endpoint:
Schema Integration
Schemas with ERD Lineage
These schemas trace fields back to database tables and columns:
Represents a book in the library catalogue with full lineage to the Book table in the database.
Schemas with Graph Database Lineage
These healthcare schemas trace fields back to graph database nodes:
Represents a patient in the healthcare system. Lineage maps to the Patient node in the healthcare graph domain model.
Embedding in Documents
Reference API endpoints directly in your architecture documentation. Use the REST API Endpoint content block to embed endpoint details inline:
Library API (ERD Lineage)
Healthcare API (Graph Database Lineage)
These endpoints demonstrate APIs with lineage to graph database models:
Additional Features
Evolution Tracking and Versioning
APIs change over time. NeoArc Studio tracks those changes with baseline-driven comparison, classifying each change as breaking, additive, deprecation, or cosmetic. The system recommends version bumps based on severity and supports a version-and-migrate workflow when major versions are needed.
Document GraphQL APIs with queries, mutations, subscriptions, custom scalars, directives, interfaces, and per-operation authentication in NeoArc Studio.
Document gRPC APIs with services, methods, four streaming types, proto message definitions, 17 status codes, 10 error detail types, interceptor chains, retry and hedging policies, HTTP transcoding, proto import and export, and a published gRPC API browser with streaming flow diagrams.
Document event-driven and asynchronous APIs with channels, operations, messages, protocol bindings for 18 protocols, 13 security schemes, reusable traits, and AsyncAPI 3.0 export in NeoArc Studio.
Document webhook-based integrations with event definitions, HMAC signature verification, delivery guarantees, retry policies, dead letter queues, circuit breakers, and consumer guidance. The structured webhook editor captures what architects need to express about push-based event notifications.
Document Model Context Protocol (MCP) servers with structured tool definitions, resource catalogues, prompt templates, transport configuration, OAuth 2.1 authentication, and capability declarations. A purpose-built editor covers the three MCP primitives that AI-powered applications depend on.
Complete reference for REST API documentation including endpoints, parameters, security schemes, responses, and OpenAPI export.
Step-by-step guide to creating REST API documentation with endpoints, parameters, schemas, and security in NeoArc Studio.
Import existing OpenAPI specifications to create REST API documentation with endpoints, schemas, and security definitions.
Track how your APIs change over time with baseline-driven comparison, structured change classification, version recommendations, and published changelogs. Covers all six API types: REST, GraphQL, gRPC, AsyncAPI, Webhooks, and MCP.