Endpoints and Parameters

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:

Optional properties:

The Endpoint Editor

The endpoint editor has four tabs:

Parameter Types

NeoArc supports four parameter locations:

Common Query Parameters

Common Header Parameters

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

Example Endpoints

Next Steps