2016-08-31 17:56:24 +00:00
|
|
|
|
# capi
|
|
|
|
|
|
|
2016-09-05 12:21:44 +00:00
|
|
|
|
Сервис предоставляющий третьим сторонам REST API для доступа к нашим системам.
|
2016-08-31 17:56:24 +00:00
|
|
|
|
|
|
|
|
|
|
## Сборка
|
|
|
|
|
|
|
|
|
|
|
|
Для запуска процесса сборки достаточно выполнить просто:
|
|
|
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
|
|
|
|
|
|
|
Чтобы запустить полученную сборку в режиме разработки и получить стандартный [Erlang shell][2], нужно всего лишь:
|
|
|
|
|
|
|
|
|
|
|
|
make start
|
|
|
|
|
|
|
|
|
|
|
|
> _Хозяйке на заметку._ При этом используется стандартный Erlang релиз, собранный при помощи [relx][3] в режиме разработчика.
|
|
|
|
|
|
|
|
|
|
|
|
## Документация
|
|
|
|
|
|
|
|
|
|
|
|
Дальнейшую документацию можно почерпнуть, пройдясь по ссылкам в [соответствующем документе](doc/index.md).
|
|
|
|
|
|
|
2016-09-05 12:21:44 +00:00
|
|
|
|
[1]: http://erlang.org/doc/man/shell.html
|
|
|
|
|
|
[2]: https://github.com/erlware/relx
|
|
|
|
|
|
[3]: https://docs.docker.com/machine/install-machine/
|
2022-04-20 12:07:35 +00:00
|
|
|
|
[4]: https://github.com/valitydev/feat
|
|
|
|
|
|
|
|
|
|
|
|
## Реализация идемпотентности запросов
|
|
|
|
|
|
|
|
|
|
|
|
Идемпотентность запросов создания/изменения сущностей обеспечивается специальной [подсистемой][4],
|
|
|
|
|
|
которая оперирует несколькими понятиями:
|
|
|
|
|
|
- ExternalId - внешний идентификатор сущности.
|
|
|
|
|
|
- Features - значимая часть данных запроса, изменение которых может появлиять на результат выполнения запроса.
|
|
|
|
|
|
- Schema - рецепт как из полной структуры данных запроса получить Features.
|
|
|
|
|
|
|
|
|
|
|
|
В случае, когда в запросе фигурирует ExternalId, сервис будет обрабатывать запрос идемпотентно.
|
|
|
|
|
|
Для структуры данных запроса существует Schema, по которой извлекается Features. Features ассоциируется с
|
|
|
|
|
|
переданным ExternalId. При повторе запроса с таким же ExternalId код извлечет Features из новых данных и
|
|
|
|
|
|
сравнит их с Features оригинального запроса, в случае совпадения сервис ответит идемпотентно, в противном случае
|
|
|
|
|
|
сервис ответит ошибкой с кодом 409.
|
2016-09-05 12:21:44 +00:00
|
|
|
|
|
2016-10-19 23:14:25 +00:00
|
|
|
|
## TODO
|
|
|
|
|
|
|
|
|
|
|
|
- Вернуть передачу в hellgate контрактора, сразу как только там появятся интерфейс и бизнес-логика управления договорами
|
2016-09-05 12:21:44 +00:00
|
|
|
|
- Ленивое создание мерчанта
|
|
|
|
|
|
- Error Mapping
|
|
|
|
|
|
- CORS (текущая версия не знает об операциях и авторизации, что в общем случае неприемлемо)
|
|
|
|
|
|
- Тотальное логирование
|
|
|
|
|
|
- При разбиению по месяцу в запросах статистики ответ приходит с разбиением по 30 дням, что не очевидно
|
|
|
|
|
|
- В сгенеренном `swagger` коде в `handle_request_json` следует учесть, что ответ вида `{false, Req1, State}` невалиден и приводит к `500` ошибке
|
|
|
|
|
|
- Перевести `capi_mock_handler` на `thrift`-чучела
|
|
|
|
|
|
- Убрать `cowlib` в тестовые зависимости, когда сборщик сможет качать тестовые зависимости
|
