Getting Started with Schemas
Create data schemas to define the structure of your APIs and documents. Learn about the four schema types and how to build your first schema.
Schemas define the structure of data in your systems. They describe what fields exist, what types those fields have, and what validation rules apply. The visual schema editor makes it easy to create and maintain schemas without writing JSON or YAML by hand.
Why Use Schemas
Documentation
Clearly communicate data structure to developers
Validation
Verify data meets requirements before processing
Code Generation
Generate types for multiple programming languages
API Contracts
Define request and response structures
Data Lineage
Track where fields originate from source systems
Consistency
Keep all systems on the same data definitions
Schema Types
NeoArc Studio supports four schema types, each for different purposes:
Example Object Schemas
Example Enum Schemas
Creating Your First Schema
Schema Properties
Every schema has these core properties:
Adding Fields
For Object and Scalar schemas, click Add Field to add a new field. Each field requires:
Field Types Overview
| Type | Description | Notes |
|---|---|---|
| String | Text values | Type specialisations for common formats (email, UUID, date-time, etc.) |
| Integer | Whole numbers | int8 to int64, bigint |
| Number | Decimal values | float, double, decimal |
| Boolean | True or false | |
| Object | Reference to another schema | Links to object schemas |
| Enum | Reference to an enum schema | Links to enum schemas |
| Array | Lists of items | Arrays of strings, integers, numbers, objects, or enums |
Example: User Schema
A typical user object schema might include: