Endpoints and Parameters
Define API endpoints with path, query, header, and cookie parameters. Configure request bodies and link to your data schemas.
Endpoints are the individual operations in your API. Each endpoint has a method, path, and configuration for parameters, request body, and responses. The structured editor keeps all endpoint details properly documented.
Creating an Endpoint
Endpoint Properties
Every endpoint requires:
| Property | Required | Description |
|---|---|---|
| ID | Yes | Unique identifier |
| Name | Yes | Human-readable operation name |
| Method | Yes | HTTP verb (GET, POST, PUT, etc.) |
| Path | Yes | URL path (e.g., /users/{id}) |
Optional properties:
The Endpoint Editor
The endpoint editor has four tabs:
Parameter Types
NeoArc supports four parameter locations:
Common Query Parameters
| Category | Parameters |
|---|---|
| Pagination | page, limit, offset |
| Sorting | sort, order |
| Filtering | filter, search, status |
| Fields | fields, include, expand |
Common Header Parameters
| Header | Purpose |
|---|---|
| X-Request-ID | Correlation identifier |
| X-API-Version | Version selection |
| Accept-Language | Localisation preference |
| X-Tenant-ID | Multi-tenant identifier |
Linking Parameters to Schemas
Each parameter type references a schema that defines the parameter fields:
Here are examples of endpoints that reference path parameter schemas. Notice how each path param schema extends a base IdPathParam schema and overrides the lineage to point to the specific domain entity:
And here is an example showing query parameters linked to a pagination schema:
Request Body
For POST, PUT, and PATCH requests, configure the request body:
Common Request Content Types
| Content Type | Use Case |
|---|---|
| application/json | Most common for REST APIs |
| application/x-www-form-urlencoded | HTML form submissions |
| multipart/form-data | File uploads with form data |
| application/xml | XML payloads |
| text/plain | Plain text |