@innet/server

 

Abstract

This package helps to create server-side application based on innet.
Here you find JSX components on back-end side 🎉, Open API generation, Swagger UI in the box, validation, formatting, cms, proxy and more.
You can create Open API documentation without implementation. It helps to define API contracts before start implementing on backend and frontend sides.

Index

Install
Handler
Usage
JSX Elements
Main
Utils
API Info
Endpoints
Primitive Data
List of Data
Run-Time
Customize
Components
Hooks

Install

← back
The simplest way to start working with @innet/server, it is innetjs usage.

npx innetjs init my-app -t api

change my-app to work folder name
Go into my-app and check README.md

Handler

← back
Use server handler to start an application.
src/index.ts

import innet from 'innet'
import server from '@innet/server'

import app from './app'

innet(app, server)

Usage

← back
Here is a Hello World example:
src/app.tsx ```typescript jsx export default (

<return>
  <success>
    Hello World!
  </success>
</return>

)

*Use `npm start` to run this server.*

Open http://localhost
You will see the `Hello Word!` string.

---

Here is the simplest [api](#api) example:

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api />
  </server>
)

Use npm start to run this server.
Open http://localhost You will see a base Open API JSON structure.

{
  "openapi": "3.1.0",
  "info": {
    "title": "",
    "version": "0.0.0"
  },
  "paths": {}
}

Main

← back
\
\
\
\

---

\

← back
<server> element helps to start http(s) server.
src/app.tsx ```typescript jsx export default ( )

#### port

Use `port` property to set up the server port:

*src/app.tsx*
```typescript jsx
export default (
  <server port={3000} />
)

• By default, it uses port 80 for http and port 443 for https.
• You can use INNET_PORT environment variable to set it up on CI level.
• innetjs allows you to use INNET_PORT in .env file of local environment.

ssl

To start https server, use ssl property:
src/app.tsx ```typescript jsx export default ( ssl={{ cert: 'url_to_file.crt', key: 'url_to_file.key', }} /> )

- You can use `INNET_SSL_KEY` and `INNET_SSL_CRT` environment variables to set it up on CI level.
- [innetjs](https://www.npmjs.com/package/innetjs) allows you to use `INNET_SSL_KEY` and `INNET_SSL_CRT` in `.env` file.
- You can add `localhost.key` and `localhost.crt` files in your project folder.

#### onStart

Use `onStart` prop to handle server start event.
You can put `httpOnStart` to the prop.
This will log URL into console after start the server.
The URL opens the server app.

*src/app.tsx*
```typescript jsx
import { httpOnStart } from '@innet/server'

export default (
  <server
    onStart={httpOnStart}
  />
)

onRequest

Use onRequest to handle any request of the server.
src/app.tsx ```typescript jsx export default ( onRequest={(req, res) => console.log({ req, res, })} /> )

#### onError

Use `onError` to handle any request error on the server.

*src/app.tsx*
```typescript jsx
export default (
  <server
    onError={error => console.error(error)}
  />
)

onClose

Use onClose to handle server close action.
src/app.tsx ```typescript jsx export default ( onClose={() => console.log('Close')} /> )

### \<api>

[← back](#main)

This element defines a REST API on the server.
This element MUST be placed in [\<server>](#server) element.

#### title

This is a title of the API.
Open API specifies the parameter is REQUIRED.
But it's NOT REQUIRED in `<api>` element, it equals [empty string](#usage) by default.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api
      title='@innet/server API'
    />
  </server>
)

description

You can add a description of the API. CommonMark syntax MAY be used for rich text representation.
src/app.tsx ```typescript jsx export default (

<api
  description='**MARKDOWN** is available'
/>

)

[innetjs](https://www.npmjs.com/package/innetjs) can help to use a separate file of description:

*src/app.tsx*
```typescript jsx
import desc from './desc.md'

export default (
  <server>
    <api description={desc} />
  </server>
)

summary

Add a short summary of the API.
src/app.tsx ```typescript jsx export default (

<api
  summary='Hello World!'
/>

)

#### version

The version of the OpenAPI document (which is distinct from the
[OpenAPI Specification version](https://swagger.io/specification/#oas-version)
or the API implementation version).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api
      title='@innet/server API'
      version='1.0.1'
    />
  </server>
)

default: INNET_API_VERSION || '0.0.0'

prefix

URL path prefix scopes the API.
src/app.tsx ```typescript jsx export default (

<api
  prefix='/api'
/>

)

*default: `INNET_API_PREFIX` || `''`*

#### include

A regular expression scopes the API.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api
      include={/^\/(api|openapi)/}
    />
  </server>
)

exclude

A regular expression does not scope the API.
src/app.tsx ```typescript jsx export default (

<api prefix='/api' />
<api prefix='/openapi' />
<api exclude={/^\/(api|openapi)/} />

)

### \<return>

[← back](#main)

This element MUST be placed in [\<server>](#server) element.
It defines a run-time call handler for parent element.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <return>
      <error status={404} />
    </return>
  </server>
)

Any request returns 404
The code runs from top to bottom and from left to right. You cannot use two \ elements one by one, the same as you cannot use two return one by one for a JS function.
src/app.tsx ```typescript jsx export default (

<return>
  <error status={404} />
</return>
<return>
  <success />
</return>

)

like

```javascript
function server () {
  return 'error'
  return 'success'
}

The second \ will newer run.
You can use \ in some elements like you use return in if or while.
src/app.tsx ```typescript jsx export default (

<env is='dev'>
  <return>
    <error status={404} />
  </return>
</env>
<return>
  <success />
</return>

)

like

```javascript
function server () {
  if (process.env.NODE_ENV === 'dev') {
    return 'error'
  }

  return 'success'
}

Place \ in \ to handle any unknown request in the \.
src/app.tsx ```typescript jsx export default (

<api>
  <return>
    <error status={404} />
  </return>
</api>

)

Place [\<return>](#return) in [\<endpoint>](#endpoint) to handle the [\<endpoint>](#endpoint) request.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/my-endpoint'>
        <return>
          <success>
            My Endpoint
          </success>
        </return>
      </endpoint>
    </api>
    <return>
      <success>
        Any other request
      </success>
    </return>
  </server>
)

You can place a component inside \. The component will run when the request will be triggered.
src/app.tsx ```typescript jsx import { GetPartners } from './GetPartners'
export default (

<api>
  <endpoint method='get' path='/partners'>
    <return>
      <GetPartners />
    </return>
  </endpoint>
</api>

)

*src/GetPartners.tsx*
```typescript jsx
export const GetPartners = () => (
  <success>
    {{partners: []}}
  </success>
)

\

← back
<preset> element MUST be placed in <server> element.
This element adds handling of each request. It works the same as \, but do not interrupt the running. You can use it to add a header or cookie or some setup of a parent element.
src/app.tsx ```typescript jsx export default (

<preset>
  <header
    key='Test'
    value='Ok'
  />
</preset>

)

Place the element inside [\<api>](#api) to preset it on the api requests scope.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api prefix='/api'>
      <preset>
        <header
          key='Cache-Control'
          value='no-cache, no-store, must-revalidate'
        />
      </preset>
      ...Endpoints
      <return>
        <success>
          Header contains `Cache-Control`
        </success>
      </return>
    </api>
    <return>
      <success>
        Header do not contain `Cache-Control`
      </success>
    </return>
  </server>
)

Utils

This section contains elements of utils.
← back
\
\
\
\
\
\

---

\

← back
Use <swagger> element to add Swagger UI documentation. <swagger> element MUST be placed in <api> element.
src/app.tsx ```typescript jsx export default (

<api>
  <swagger />
</api>

)

Open http://localhost:80/swagger-ui
You will see Swagger UI documentation.

You can change the Swagger UI URL path by `path` property of `<swagger>` element.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <swagger path='/swagger' />
    </api>
  </server>
)

\

← back
This element helps to control content by process.env.
There are a required field of is. If it's a string then an environment variable must be equal to the string. If it's an array of string then an environment variable must be included into the array of string.
src/app.tsx ```typescript jsx export default (

<api>
  <env is='dev'>
    <swagger />
  </env>
</api>

)

*The `<swagger />` will work only if `NODE_ENV` equals `dev`*

#### of

By default `of` equals `NODE_ENV`. You can check eny other environment variable.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <env
        of='PORT'
        is={[
          '3000',
          '8080',
        ]}>
        <swagger />
      </env>
    </api>
  </server>
)

\

← back
Use <dts> element to add types generation. <dts> element MUST be placed in <api> element.
src/app.tsx ```typescript jsx export default (

<api>
  <dts />
</api>

)

You do not need to import types, use `Api` namespace everywhere.
Here is an example of generated types usage.

```typescript jsx
import { useParams } from '@innet/server'

import { todos } from '../todos'

export function DeleteTodo () {
  const { todoId } = useParams<Api.Endpoints['DELETE:/todos/{todoId}']['Params']>()

  const todoIndex = todos.findIndex(({ id }) => id === todoId)

  if (todoIndex === -1) {
    return <error code='todoNotFound' status={404} />
  }

  todos.splice(todoIndex, 1)

  return <success />
}

path

This is a path of api TypeScript types file, <dts> generates it. 'src/api.d.ts' by default.
src/app.tsx ```typescript jsx export default (

<api>
  <dts path='src/types.d.ts' />
</api>

)

#### namespace

This prop changes namespace for generated types. `'Api'` by default.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <dts namespace='API' />
    </api>
  </server>
)

\

This element MUST be placed in <api> element.
← back
This element returns own content for a user from IPs list.
src/app.tsx ```typescript jsx export default (

<api>
  <blacklist>
    <error />
  </blacklist>
</api>

)

#### ip

`ip` prop sets black IPs. By default, it equals `INNET_BLACKLIST_IP` node environment variable.

You can split IPs by `,` char.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <blacklist
        ip='0.1.2.3,3.2.1.0'>
        <error />
      </blacklist>
    </api>
  </server>
)

\

This element MUST be placed in <api> element.
← back
This element returns own content for a user IP, which is not in a list.
src/app.tsx ```typescript jsx export default (

<api>
  <whitelist>
    <error />
  </whitelist>
</api>

)

#### ip

`ip` prop sets white IPs. By default, it equals `INNET_WHITELIST_IP` node environment variable.

You can split IPs by `,` char.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <whitelist
        ip='0.1.2.3,3.2.1.0'>
        <error />
      </whitelist>
    </api>
  </server>
)

\

This element MUST be placed in <api> element.
← back
This element adds protection page. You can use it when you want to protect your application.
If protection failed content of the element should be used.
src/app.tsx ```typescript jsx export default (

<api>
  <protection>
    <error
      code='protection'
      status='forbidden'
    />
  </protection>
</api>

)

#### value

This prop is a secret string of protection value.
User must provide a protection query param equals the `value`.

By default, the value is `undefined` and protection does not work.
You can use `PROTECTION` env to set default protection `value`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <protection value='secret'>
        <error
          code='protection'
          status='forbidden'
        />
      </protection>
    </api>
  </server>
)

maxAge

This prop sets how much time protection is qualified.
By default, the prop equals a year. You can use INNET_PROTECTION_MAX_AGE env to set default maxAge.
src/app.tsx ```typescript jsx export default (

<api>
  <protection
    maxAge={24 * 60 * 60}
    value='secret'>
    <error
      code='protection'
      status='forbidden'
    />
  </protection>
</api>

)

#### excludeIp

This prop sets a list of IP addresses (split by `,`) to ignore the protection.

You can use `INNET_PROTECTED_IP` env to set default `excludeIp`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <protection
        excludeIp='0.0.0.0,127.0.0.0'
        value='secret'>
        <error
          code='protection'
          status='forbidden'
        />
      </protection>
    </api>
  </server>
)

cookieKey

This prop sets a cookie field name used to store protection of a user.
By default, it equals protection. You can use INNET_PROTECTION_COOKIE_KEY env to set default cookieKey.
src/app.tsx ```typescript jsx export default (

<api>
  <protection
    cookieKey='secret'
    value='secret'>
    <error
      code='protection'
      status='forbidden'
    />
  </protection>
</api>

)

#### searchKey

This prop sets a search query field name used to check protection.

By default, it equals `protection`.
You can use `INNET_PROTECTION_SEARCH_KEY` env to set default `searchKey`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <protection
        searchKey='secret'
        value='secret'>
        <error
          code='protection'
          status='forbidden'
        />
      </protection>
    </api>
  </server>
)

API Info

The API information elements are here.
← back
\
\
\
\

---

\

← back
<license> element MUST be placed in <api> element. Use <license> element to define the API license.

name

REQUIRED prop. The license name used for the API.
src/app.tsx ```typescript jsx export default (

<api>
  <license
    name='Apache 2.0'
  />
</api>

)

#### identifier

An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API.
The `identifier` field is mutually exclusive of the `url` prop.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <license
        name='Apache 2.0'
        identifier='Apache-2.0'
      />
    </api>
  </server>
)

url

A URL to the license used for the API. This MUST be in the form of a URL. The url field is mutually exclusive of the identifier field.
src/app.tsx ```typescript jsx export default (

<api>
  <license
    name='Apache 2.0'
    url='https://www.apache.org/licenses/LICENSE-2.0.html'
  />
</api>

)

### \<contact>

[← back](#api-info)

`<contact>` element MUST be placed in `<api>` element.
The contact information for the exposed API.

#### name

The identifying name of the contact person/organization.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <contact name='Mike' />
    </api>
  </server>
)

email

The email address of the contact person/organization. This MUST be in the form of an email address.
src/app.tsx ```typescript jsx export default (

<api>
  <contact
    email='d8@cantinc.com'
  />
</api>

)

#### url

The URL pointing to the contact information.
This MUST be in the form of a URL.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <contact
        url='https://...'
      />
    </api>
  </server>
)

\

← back
<host> element MUST be placed in <api> element.
This element adds a link to related documentation API. You can provide many stands like dev, stage or prod.

url

REQUIRED prop of URL to the target host.
This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.
src/app.tsx ```typescript jsx export default (

<api>
  <host
    url='https://your.address/api'
  />
</api>

)

#### description

An optional string describing the host designated by the URL.
[CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <host
        url='https://your.address/api'
        description='Production server'
      />
    </api>
  </server>
)

\

← back
This element MUST be placed in <host> element and defines a variable from the <host>.

key

REQUIRED props. key is a server url parameter.
src/app.tsx ```typescript jsx export default (

<api>
  <host
    url='https://{env}.your.address/api'
    description='Test servers'>
    <variable key='env' />
  </host>
</api>

)

#### value

The `value` prop uses for substitution by default.
If the `values` is defined, the `value` MUST exist in the `values`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <host
        url='https://{env}.your.address/api'
        description='Test servers'>
        <variable
          key='env'
          value='stage'
        />
      </host>
    </api>
  </server>
)

values

An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.
src/app.tsx ```typescript jsx export default (

<api>
  <host
    url='https://{env}.your.address/api'
    description='Test servers'>
    <variable
      key='env'
      values={[
        'stage',
        'dev',
        'qa',
      ]}
    />
  </host>
</api>

)

#### description

An optional description for the server variable.
[CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <host
        url='https://{env}.your.address/api'
        description='Test servers'>
        <variable
          key='env'
          values={[
            'stage',
            'dev',
            'qa',
          ]}
          description='Server environment'
        />
      </host>
    </api>
  </server>
)

Endpoints

← back
\
\
\
\
\

---

\

← back
<endpoint> defines an endpoint of the API and MUST be placed in <api>.
<api> uses a specific algorithm to find expected endpoint.
It does no matter how many endpoints you have. It depends on the deep of path pieces. If you have the deep equals 1 (/users, /user, /login, /logout) the endpoint will be found immediately O(1).

method

A method of the endpoint.
MUST be one of 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'trace'

path

A relative path to an individual endpoint.
The property MUST begin with a forward slash (/).
Path templating is allowed.
When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint
    method='get'
    path='/users'
  />
</api>

)

#### summary

An optional, string summary, intended to apply to all operations in this path.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint
        method='get'
        path='/users'
        summary='Returns users'
      />
    </api>
  </server>
)

description

An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint
    method='get'
    path='/users'
    description='Users list query'
  />
</api>

)

#### deprecated

Declares this operation to be deprecated.
Consumers SHOULD refrain from usage of the declared operation.
Default value is `false`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint
        method='get'
        path='/users'
        deprecated
      />
    </api>
  </server>
)

private

Declares this operation to make an endpoint private. That means the endpoint should not be described and will not be shown in the Open API documentation.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint
    method='get'
    path='/users'
    private
  />
</api>

)

### \<tag>

[← back](#endpoints)

You can wrap endpoints by `<tag>` element to group the endpoints.
You can see the changes in Swagger UI.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <tag name='user'>
        <endpoint
          method='get'
          path='/users'
        />
        <endpoint
          method='post'
          path='/users'
        />
      </tag>
    </api>
  </server>
)

\

← back
Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.

Parameter Locations

There are four possible parameter locations specified by the in prop:

• path - Used together with Path Templating, where the parameter value is actually part of the operation's URL.

This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

• query - Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
• header - Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.
• cookie - Used to pass a specific cookie value to the API.

in

The location of the parameter. Possible values are "query", "header", "path" or "cookie".

name

The name of the parameter. Parameter names are case sensitive.

• If in is "path", the name field MUST correspond to a template expression occurring within the path field in the endpoint. See Path Templating for further information.
• If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
• For all other cases, the name corresponds to the parameter name used by the in property.

src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users/{userId}'>
    <param in='path' name='userId' />
  </endpoint>
</api>

)

#### description

A brief description of the parameter.
This could contain examples of use.
[CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users/{userId}'>
        <param
          in='path'
          name='userId'
          description='User identification number'
        />
      </endpoint>
    </api>
  </server>
)

required

Determines whether this parameter is mandatory. If the parameter location is "path", this property is true and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='cookie'
      name='token'
      required
    />
  </endpoint>
</api>

)

#### deprecated

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
Default value is `false`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='status'
          deprecated
        />
      </endpoint>
    </api>
  </server>
)

\

← back
This element MUST be placed inside <endpoint>. It defines request body for the endpoint. @innet/server formats and validate the value automatically (real-time).
src/app.tsx ```typescript jsx return (

<api>
  <endpoint method='post' path='/partners'>
    <body>
      <object>
        <field key='name'>
          <string example='CANTent.' />
        </field>
        <field key='gift'>
          <boolean />
        </field>
        <field optional key='addresses'>
          <array>
            <number description='address id' />
          </array>
        </field>
      </object>
    </body>
  </endpoint>
</api>

)

### \<response>

[← back](#endpoints)

This element MUST be placed inside `<endpoint>`.
It defines response body for the endpoint.

*src/app.tsx*
```typescript jsx
return (
  <server>
    <api>
      <endpoint method='get' path='/settings'>
        <response>
          <object />
        </response>
      </endpoint>
    </api>
  </server>
)

status

A status of the <response>. Any HTTP status code can be used as a number of the property.
By default, status equals 'default'.
src/app.tsx ```typescript jsx return (

<api>
  <endpoint method='get' path='/settings'>
    <response status={200}>
      <object />
    </response>
  </endpoint>
</api>

)

To define a range of response codes, this field MAY contain the uppercase wildcard character `X`.
For example, `2XX` represents all response codes between \[200-299].
Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX` and `5XX`.

*src/app.tsx*
```typescript jsx
return (
  <server>
    <api>
      <endpoint method='get' path='/settings'>
        <response status='2XX'>
          <object />
        </response>
      </endpoint>
    </api>
  </server>
)

Many number statuses have a string id you can use on the property.
src/app.tsx ```typescript jsx return (

<api>
  <endpoint method='get' path='/settings'>
    <response status='notFound'>
      <object />
    </response>
  </endpoint>
</api>

)

You can use many `<response>` elements in an endpoint.

*src/app.tsx*
```typescript jsx
return (
  <server>
    <api>
      <endpoint method='get' path='/settings'>
        <response status='2XX'>
          <object />
        </response>
        <response status='4XX'>
          <object>
            <field key='error'>
              <string />
            </field>
            <field optional key='data'>
              <object />
            </field>
          </object>
        </response>
      </endpoint>
    </api>
  </server>
)

type

A media type of the <response>.
By default, type equals 'application/json'.
src/app.tsx ```typescript jsx return (

<api>
  <endpoint method='get' path='/hello'>
    <response type='text/html'>
      Hello World!
    </response>
  </endpoint>
</api>

)

## Primitive Data

[← back](#index)

[\<any>](#any)  
[\<null>](#null)  
[\<boolean>](#boolean)  
[\<string>](#string)  
[\<number>](#number)  
[\<integer>](#integer)  
[\<date>](#date)  
[\<uuid>](#uuid)  
[\<binary>](#binary)

---

### \<any>

[← back](#primitive-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `any` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/todos'>
        <param
          in='query'
          name='search'>
          <any />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the any.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='search'>
      <any default={null} />
    </param>
  </endpoint>
</api>

)

#### example

An example value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param
          in='query'
          name='active'>
          <any example={false} />
        </param>
      </endpoint>
    </api>
  </server>
)

description

A description of the any.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param
      in='query'
      name='active'>
      <any
        description='Active products param'
      />
    </param>
  </endpoint>
</api>

)

### \<null>

[← back](#primitive-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `null` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/todos'>
        <param
          in='query'
          name='search'>
          <null />
        </param>
      </endpoint>
    </api>
  </server>
)

description

A description of the null.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param
      in='query'
      name='active'>
      <null description='FIXME!' />
    </param>
  </endpoint>
</api>

)

### \<boolean>

[← back](#primitive-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `boolean` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='active'>
          <boolean />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the boolean.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='active'>
      <boolean default={false} />
    </param>
  </endpoint>
</api>

)

#### example

An example value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param
          in='query'
          name='active'>
          <boolean example={false} />
        </param>
      </endpoint>
    </api>
  </server>
)

description

A description of the boolean.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param
      in='query'
      name='active'>
      <boolean
        description='Active products param'
      />
    </param>
  </endpoint>
</api>

)

### \<string>

[← back](#primitive-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `string` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='search'>
          <string />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the string.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='status'>
      <string default='active' />
    </param>
  </endpoint>
</api>

)

*By default, `status` query param equals `active`*

#### example

An example value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param
          in='query'
          name='search'>
          <string example='red socks' />
        </param>
      </endpoint>
    </api>
  </server>
)

description

A description of the string.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param
      in='query'
      name='search'>
      <string
        description='A search string'
      />
    </param>
  </endpoint>
</api>

)

#### values

The enumeration of available `values`.
If you provide the parameter value, which is not in the `values`, the server returns an error.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='status'>
          <string
            default='active'
            values={[
              'active',
              'inactive',
            ]}
          />
        </param>
      </endpoint>
    </api>
  </server>
)

min, max

Those two props validate the string value by minimum and maximum length.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='name'>
      <string min={1} max={128} />
    </param>
  </endpoint>
</api>

)

#### pattern

A `string` of `RegExp` or `RegExp`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='friendlyName'>
          <string pattern='^[a-z_0-9]+$' />
        </param>
      </endpoint>
    </api>
  </server>
)

If you make a request to the API endpoint, with query parameter of friendlyName equals no-friendly (as example), you get an error:

{
  "error": "requestValidation",
  "data": {
    "error": "reg",
    "data": {
      "key": "friendlyName"
    },
    "in": "search"
  }
}

patternId

This property adds an id of the pattern expression in error response. For example, You can use the id to load error message translations.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='friendlyName'>
      <string
        pattern='^[a-z_0-9]+$'
        patternID='fname'
      />
    </param>
  </endpoint>
</api>

)

If you make a request to the API endpoint,
with query parameter of `friendlyName` equals `no-friendly` (as example),
you get an error:

```json
{
  "error": "requestValidation",
  "data": {
    "error": "reg",
    "data": {
      "key": "friendlyName",
      "regId": "fname"
    },
    "in": "search"
  }
}

\

← back
The element MUST be placed inside one of \, \, \. It defines number value for a parent element. @innet/server formats and validate the value automatically (real-time).
Correct numbers are from -9007199254740991 to 9007199254740991. This is a value of Number.MAX_SAFE_INTEGER.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <number />
    </param>
  </endpoint>
</api>

)

*This example defines a `GET` endpoint on `/users` which has an optional query `number` parameter of `minAge`.*

#### default

A default value for the `number`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='minAge'>
          <number default={18} />
        </param>
      </endpoint>
    </api>
  </server>
)

By default, minAge query param equals 18

example

An example value.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <number example={18} />
    </param>
  </endpoint>
</api>

)

#### description

A description of the `number`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='minAge'>
          <number
            example={18}
            description='Age value'
          />
        </param>
      </endpoint>
    </api>
  </server>
)

values

The enumeration of available values. If you provide the parameter value, which is not in the values, the server returns an error.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <number
        example={18}
        values={[
          12,
          16,
          18,
          21,
        ]}
      />
    </param>
  </endpoint>
</api>

)

#### min, max

Those two props validate the number value by minimum and maximum values.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='rating'>
          <number min={1} max={5} />
        </param>
      </endpoint>
    </api>
  </server>
)

In this example /products?rating=5 is valid and /products?rating=6 is not

\

← back
The element MUST be placed inside one of \, \, \. It defines integer value for a parent element. @innet/server formats and validate the value automatically (real-time).
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <integer />
    </param>
  </endpoint>
</api>

)

*This example defines a `GET` endpoint on `/users` which has an optional query `integer` parameter of `minAge`.*

#### format

You can set up the `integer` format.
Possible values are `int32` or `int64`.
By default, there are `int32` used.

The format of `int32` means a number from `-2147483647` to `2147483647`.
The format of `int64` converts the value to `BigInt` and placed between `-9223372036854775807` and `9223372036854775807`


*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='minAge'>
          <integer format='int64' />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the integer.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <integer default={18} />
    </param>
  </endpoint>
</api>

)

*By default, `minAge` query param equals `18`*

#### example

An example value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='minAge'>
          <integer example={18} />
        </param>
      </endpoint>
    </api>
  </server>
)

description

A description of the integer.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='minAge'>
      <integer
        example={18}
        description='Age value'
      />
    </param>
  </endpoint>
</api>

)

#### values

The enumeration of available `values`.
If you provide the parameter value, which is not in the `values`, the server returns an error.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='minAge'>
          <integer
            example={18}
            values={[
              12,
              16,
              18,
              21,
            ]}
          />
        </param>
      </endpoint>
    </api>
  </server>
)

min, max

Those two props validate the number value by minimum and maximum values.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='rating'>
      <integer min={1} max={5} />
    </param>
  </endpoint>
</api>

)

*In this example `/products?rating=5` is valid and `/products?rating=6` is not*

### \<date>

[← back](#primitive-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `date` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='birthday'>
          <date />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the date. Available values:

• string - the date in ISO format
• number - date timestamp
• Date - JavaScript Date format
• 'now' - the string defines current date as default value.

src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='birthday'>
      <date default='1950-02-15' />
    </param>
  </endpoint>
</api>

)

#### values

The enumeration of available `values`.
If you provide the parameter value, which is not in the `values`, the server returns an error.

Available values:
- `string` - the date in ISO format
- `number` - date timestamp
- `Date` - JavaScript `Date` format

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='birthday'>
          <date
            values={[
              1,
              new Date(),
              '1950-02-15',
            ]}
          />
        </param>
      </endpoint>
    </api>
  </server>
)

example

An example value.
Available values:

• string - the date in ISO format
• number - date timestamp
• Date - JavaScript Date format
• 'now' - the string defines server start date as example.

src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='birthday'>
      <date example={0} />
    </param>
  </endpoint>
</api>

)

#### description

A description of the `date`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/users'>
        <param
          in='query'
          name='birthday'>
          <date
            description='The user birthday'
          />
        </param>
      </endpoint>
    </api>
  </server>
)

min, max

Those two pros limit the date period.
Available values:

• string - the date in ISO format
• number - date timestamp
• Date - JavaScript Date format
• 'now' - the string defines current server date as default.

src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/users'>
    <param
      in='query'
      name='birthday'>
      <date
        min='01-01-1900'
        max='now'
        description='The user birthday'
      />
    </param>
  </endpoint>
</api>

)

### \<uuid>

[← back](#primitive-data)

Universally unique identifier.

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `string` value in `uuid` format for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <param
          in='cookie'
          name='userId'>
          <uuid />
        </param>
      </endpoint>
    </api>
  </server>
)

default

A default value for the uuid.
Available values:

• string in uuid format
• new generates a new uuid

src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/users'>
    <param
      in='cookie'
      name='userId'>
      <uuid default='new' />
    </param>
  </endpoint>
</api>

)

#### values

The enumeration of available `values`.
If you provide the parameter value, which is not in the `values`, the server returns an error.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <param
          in='header'
          name='uuid'>
          <uuid
            values={[
              '123e4567-e89b-12d3-a456-426655440000',
              '123e4567-e89b-12d3-a456-426614174000',
            ]}
          />
        </param>
      </endpoint>
    </api>
  </server>
)

example

An example value.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/users'>
    <param
      in='query'
      name='active'>
      <uuid
        default='new'
        example='123e4567-e89b-12d3-a456-426655440000'
      />
    </param>
  </endpoint>
</api>

)

#### description

A description of the `boolean`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <param
          in='cookie'
          name='userId'>
          <uuid
            default='new'
            example='123e4567-e89b-12d3-a456-426655440000'
            description='User ID for a new user'
          />
        </param>
      </endpoint>
    </api>
  </server>
)

\

← back
This is a binary type of data. There is one way to get the type, it is multipart/form-data usage.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/partner'>
    <body>
      <object>
        <field key='icon'>
          <binary />
        </field>
        <field key='name'>
          <string />
        </field>
      </object>
    </body>
  </endpoint>
</api>

)

#### description

A description of the `binary`.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/partner'>
        <body>
          <object>
            <field key='icon'>
              <binary
                description='Square icon of the partner'
              />
            </field>
          </object>
        </body>
      </endpoint>
    </api>
  </server>
)

accept

This prop defines available file format. It works the same as accept attribute of HTML input element.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/partner'>
    <body>
      <object>
        <field key='icon'>
          <binary
            accept='image/jpeg'
            description='Square icon of the partner'
          />
        </field>
      </object>
    </body>
  </endpoint>
</api>

)

#### min, max

Those two pros limit the file size.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/partner'>
        <body>
          <object>
            <field key='icon'>
              <binary
                accept='image/jpeg'
                description='Square icon of the partner'
                min={1024}
                max={10 * 1024 ** 2}
              />
            </field>
          </object>
        </body>
      </endpoint>
    </api>
  </server>
)

List of Data

← back
\
\
\
\
---

\

← back
<tuple> element specifies schema parameter as a tuple of children elements.
The element MUST be placed inside one of \, \, \.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param name='rating' in='query'>
      <tuple>
        <number min={1} max={5} />
        <number min={1} max={5} />
      </tuple>
    </param>
  </endpoint>
</api>

)

This example defines that, `/products?rating=3&rating=4` is valid and `rating` MUST be from `3` to `4`.
Also supports formats `/products?rating[]=3&rating[]=4` and `/products?rating[0]=3&rating[1]=4`.

`/products?rating=3` or `/products?rating=1&rating=6` returns an error.

You can add several elements in [\<response>](#response), [\<param>](#param) or [\<body>](#body) to define that one of the element is valid.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='rating'>
          <number min={1} max={5} />
          <tuple>
            <number min={1} max={5} />
            <number min={1} max={5} />
          </tuple>
        </param>
      </endpoint>
    </api>
  </server>
)

This example defines that, /products?rating=3&rating=4 is valid and rating MUST be from 3 to 4. Also supports /products?rating=3, returns products have rating equals 3.
/products?rating=text or /products?rating=1&rating=6 returns an error.

default

Defines default <tuple> value.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='rating'>
      <number min={1} max={5} />
      <tuple default={[1, 5]}>
        <number min={1} max={5} />
        <number min={1} max={5} />
      </tuple>
    </param>
  </endpoint>
</api>

)

#### example

Defines an example of the `<tuple>` value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='rating'>
          <number min={1} max={5} />
          <tuple default={[1, 5]} example={[3, 5]}>
            <number min={1} max={5} />
            <number min={1} max={5} />
          </tuple>
        </param>
      </endpoint>
    </api>
  </server>
)

description

Defines the <tuple> description.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='rating'>
      <number min={1} max={5} />
      <tuple
        description='A range of rating score'
        default={[1, 5]}
        example={[3, 5]}>
        <number min={1} max={5} />
        <number min={1} max={5} />
      </tuple>
    </param>
  </endpoint>
</api>

)

### \<array>

[← back](#list-of-data)

`<array>` element specifies schema parameter as an array of children elements.

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='rating'>
          <array>
            <number min={1} max={5} />
          </array>
        </param>
      </endpoint>
    </api>
  </server>
)

This example defines that, /products?rating=3&rating=4 is valid and rating MUST be 3 or 4. Also supports formats /products?rating[]=3&rating[]=4 and /products?rating[0]=3&rating[1]=4.
/products?rating=3 and /products?rating=1&rating=2&rating=3 also support.

default

Defines default <array> value.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='rating'>
      <array default={[1, 2, 3, 4, 5]}>
        <number min={1} max={5} />
      </array>
    </param>
  </endpoint>
</api>

)

#### example

Defines an example of the `<array>` value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='get' path='/products'>
        <param in='query' name='rating'>
          <array example={[1, 3, 5]}>
            <number min={1} max={5} />
          </array>
        </param>
      </endpoint>
    </api>
  </server>
)

description

Defines the <array> description.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='get' path='/products'>
    <param in='query' name='rating'>
      <array
        description='Values of rating score'
        example={[3, 5]}>
        <number min={1} max={5} />
      </array>
    </param>
  </endpoint>
</api>

)

### \<object>

[← back](#list-of-data)

The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
It defines `object` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <body>
          <object>
            <string />
          </object>
        </body>
      </endpoint>
    </api>
  </server>
)

default

A default value for the object.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/users'>
    <body>
      <object
        default={{name: 'John'}}
      />
    </body>
  </endpoint>
</api>

)

#### example

An example value.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <body>
        <object
          example={{name: 'John'}}
        />
        </body>
      </endpoint>
    </api>
  </server>
)

description

A description of the object.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/users'>
    <body>
      <object
        description='The object of a user'
      />
    </body>
  </endpoint>
</api>

)

### \<field>

[← back](#list-of-data)

The element MUST be placed inside [\<object>](#object).
It defines a `field` of an `object` value for a parent element.
`@innet/server` formats and validate the value automatically (real-time).

`key` is REQUIRED prop of `<field>`, it defines a field name of the [\<object>](#object).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <body>
          <object>
            <field key='name' />
            <field key='surname' />
            <field key='birthbay' />
          </object>
        </body>
      </endpoint>
    </api>
  </server>
)

optional

By default, any field is required. You can set it as optional by this prop.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint method='post' path='/users'>
    <body>
    <object>
      <field key='name' />
      <field key='surname' />
      <field optional key='birthbay' />
    </object>
    </body>
  </endpoint>
</api>

)

#### deprecated

You can deprecate a field.

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <api>
      <endpoint method='post' path='/users'>
        <body>
        <object>
          <field key='name' />
          <field key='surname' />
          <field deprecated optional key='birthbay' />
        </object>
        </body>
      </endpoint>
    </api>
  </server>
)

Run-Time

Next elements relate to run-time action. This action calls on user request.
← back
\
\
\
\
\
\
\

\

---

\

← back
This is a base element to return a success data.
src/app.tsx ```typescript jsx export default (

<return>
  <success />
</return>

)

You will get a response with `204` status (`noContent`) and without content.

You can provide some data to the user by children.

*src/app.tsx*
```typescript jsx
const data = {...}

export default (
  <server>
    <return>
      <success>
        {data}
      </success>
    </return>
  </server>
)

You will get 200 status (ok), with body equals data.

status

You can set response status by status prop of <success>.
src/app.tsx ```typescript jsx const data = {...}
export default (

<return>
  <success status='created'>
    {data}
  </success>
</return>

)

You will get `201` status (`created`), with data as a content.

You can use a number of `status` prop.

*src/app.tsx*
```typescript jsx
const data = {...}

export default (
  <server>
    <return>
      <success status={201}>
        {data}
      </success>
    </return>
  </server>
)

contentType

This props sets response content type. By default, it checks children element to define the prop.
src/app.tsx ```typescript jsx export default (

<return>
  <success contentType='text/html'>
    Hello World!
  </success>
</return>

)

### \<error>

[← back](#run-time)

Returns an error.
This element MUST be placed in [\<return>](#return).

*src/app.tsx*
```typescript jsx
export default (
  <server>
    <return>
      <error />
    </return>
  </server>
)

Place a data into the element to return an error with the data.
src/app.tsx ```typescript jsx const data = {...}
export default (

<return>
  <error>
    {data}
  </error>
</return>

)

#### status
You can change response status by `status` prop. By default, it is `520` (`unknownError`)

*src/app.tsx*
```typescript jsx
const data = {
  message: 'User not found!'
}

export default (
  <server>
    <return>
      <error status='notFound'>
        {data}
      </error>
    </return>
  </server>
)

You can use a number with the status prop.
src/app.tsx ```typescript jsx const data = { message: 'User not found!' }
export default (

<return>
  <error status={404}>
    {data}
  </error>
</return>

)

#### code
When you use `<error>` element a user get next response body.

*for the previous example*
```json
{
  "error": "undefined",
  "data": {
    "message": "User not found!"
  }
}

You can change the error code by code property.
src/app.tsx ```typescript jsx const data = { message: 'User not found!' }
export default (

<return>
  <error
    code='noUser'
    status='notFound'>
    {data}
  </error>
</return>

)

Then you get

*for the previous example*
```json
{
  "error": "noUser",
  "data": {
    "message": "User not found!"
  }
}

There are some default errors:

• undefined - when you use <error> element without code.
• requestValidation - when request data fails schema validation.
• requestBodyContentType - when cannot parse body.
• unknown - can because of JSON stringify fail or other errors.

\

← back
MUST be placed in \.
You can easy proxy endpoints to another server/service.
src/app.tsx ```typescript jsx export default (

<api>
  <endpoint
    path='/test'
    method='get'>
    <return>
      <pro