Getting Started with REST APIs
Create a REST API projection sourced from your canonical model. Define endpoints, wire request and response bodies to schema entities, and configure security.
REST APIs in NeoArc Studio are authored as API projections. A projection transforms your canonical model into a purpose-specific representation - in this case, an HTTP-shaped API with endpoints, request/response bodies, parameters, and security. The endpoints trace back through the projection to the model entities they expose, so any change to the model surfaces directly on the endpoints that use it.
Why author APIs as projections
Model-First
Every endpoint request and response traces back to entities in your canonical model
Shared Schemas
Schema projections let multiple APIs reuse the same types without copy-paste
Impact Analysis
Changing a model property shows every endpoint that will be affected, before you save
OpenAPI Export
Publish to OpenAPI 3.1 for client generation, Postman, or other API tooling
Security as Contract
HTTP auth, API keys, OAuth 2.0, and mTLS schemes attached to endpoints with per-operation overrides
Versioning
Each projection tracks its version format and version string for baseline-driven evolution
Create a REST API projection
Key concepts
Next steps
Projections overview
Understand the unified projection system that underpins database, search, schema, API and UI projections
Schema projections
Build a shared type library so multiple APIs can reference the same request and response types
Baseline evolution
Track breaking, additive, deprecation and cosmetic changes to your API over time