Введение в документацию по настройке шаблона API

Шаблон API

Шаблон использует конфигурацию Velocity (http://velocity.apache.org/engine/devel/user-guide.html#Velocity_Template_Language_VTL:_An_Introduction).

Основные параметры встроенного интерфейса REST API включают: URL, метод HTTP, параметры запроса, параметры пути, тело сообщения и ответное сообщение.

Параметры запроса и параметры пути являются массивами.

Метод HTTP и путь запроса

Параметры запроса и пути

Описание свойств объекта параметра

Запрос и ответ

Пример шаблона (Markdown API документ)

## Стандартный шаблон API Markdown
## Это строка комментария шаблона
## ##[[Здесь может быть любой контент, который не будет экранирован]]##

**Путь запроса**

`$method $url`

#if ($hasQueryParams)
**Параметры запроса**

|Параметр|Тип|Описание|
|:---|:---|:---|
#foreach($p in $queryParams)
|$p.name|$p.alias|$p.desc|
#end
#end

#if ($hasPathVariables)
**Переменные пути**

|Параметр|Тип|Описание|
|:---|:---|:---|---|
#foreach($p in $pathVariables)
|$p.name|$p.alias|$p.desc|
#end
#end

#if ($hasBody)
**Пример запроса**
```json5
$body
```
#end

#if ($hasResponse)
**Пример ответа**
```json5
$response
```
#end

Переменные пути

Анализируются только параметры контроллера с аннотацией @PathVariable.

Настройка параметров запроса

Игнорирование типов

Типы параметров метода контроллера не анализируются как параметры запроса в конфигурации.

Игнорировать аннотации

Аннотации, настроенные для параметров метода контроллера, не анализируют параметры запроса.

Тело сообщения

Игнорируются поля объекта запроса и объекта ответа с настроенными аннотациями в списке полей.

Сериализация

Объекты запроса и ответа сериализуются в соответствии с типом в формате JSON5.