Salt Json Specification

Спецификация Salt:API для использования в REST сервисах и frontend.
Версия 0.5.0

Внимание!
Спецификация в версии Pre-Release
В случае обнуружения ошибок, неточностей или необходимости исправлений, просьба создавать ISSUE.

Формат документации

Чтобы начать работу с Salt:API, ознакомьтесь с документацией по спецификации

Оглавление

• Спецификация
  • Соглашения по использованию HTTP методов
    • POST
    • GET
    • PUT
    • PATCH
    • DELETE
  • Соглашения по телу запроса
    • Первичные данные
    • Ошибки
    • Ссылки
    • Метаинформация
  • Соглашения по ограничениям запрашиваемых данных
    • Фильтры
    • Сортировка
    • Pagination
    • Разреженные наборы полей
  • Примеры
    • HTTP GET object
    • HTTP GET collection
    • HTTP POST create object
    • HTTP POST get collection with filters and pagination
    • HTTP PUT
    • HTTP PATCH
    • HTTP DELETE

RoadMap

1. Исправления битых ссылок после форматирования
2. Добавить в примеры варианты ошибок
3. swagger

История изменений