Ресурсно-ориентированный дизайн

Цель этого руководства по дизайну - помочь разработчикам разработать простые, последовательные и простые в использовании API.

API RPC часто разрабатываются с точки зрения интерфейсов и методов. Поскольку все больше и больше фич добавляются со временем, в конечном итиоге API может быть очень запутанным, разработчики должны будут изучать каждый метод индивидуально. Очевидно, это будет тратить много время и будет приводить к ошибкам.

Проектирование API

Предлагается выполнить следующие шаги при разработке API-интерфейсов, ориентированных на ресурсы:

Определите, какие типы ресурсов предоставляет API Определите отношения между ресурсами Определите схемы имен ресурсов на основе типов и отношений Определите структуру ресурсов Приложите минимальный набор методов к ресурсам