RESTful APIs, управляемые поведением

В примере RESTBucks авторы представляют полезную диаграмму состояний, которая описывает действия, которые клиент может выполнять с сервисом.

Откуда такая диаграмма состояния приложения? Ну, это вытекает из требований, конечно.

Поскольку мне нравится определять требования с помощью примеров , давайте посмотрим, как мы можем получить диаграмму состояния приложения из требований стиля BDD .

Пример: диаграмма состояния RESTBucks

Вот три сценария для истории заказа напитка :

Давайте посмотрим на это более подробно, начиная со сценария счастливого пути .

Первая строка говорит мне, что есть служба REST, по некоторому заданному URL рекламного щита . Вторая строка говорит мне, что я могу использовать метод POST для этого URI, чтобы создать ресурс Order с заданными свойствами.

Это говорит мне, что POST возвращает 201 с расположением созданного ресурса Order.

Это говорит мне, что существует pay действие (отношение ссылки).

Это говорит мне, что ответ действия pay содержит представление ресурса Receipt.

Это говорит мне, что есть ссылка с ресурса Receipt обратно на ресурс Order. Это также говорит мне, что Заказ теперь находится в paid статусе.

Это говорит мне, что я могу обновить Order, используя GET пока какой-то другой процесс не изменит свое состояние на ready .

Это говорит мне, что есть действие (ссылка).

Это говорит мне, что Орден сейчас в completed состоянии.

Анализ двух других сценариев аналогичным образом дает нам диаграмму состояний, которая очень похожа на исходную в примере RESTBucks.

Единственное отличие состоит в том, что эта диаграмма содержит дополнительное действие для перехода от получения к заказу. Эта навигация также описана в книге, но не показана на схеме в книге.

Использование методов BDD для разработки RESTful API

Используя сценарии BDD, довольно просто обнаружить диаграмму состояния приложения. Это не должно вызывать удивления, поскольку синтаксис Given/When/Then сценариев BDD — это просто еще один способ описания состояний и переходов между состояниями.

От диаграммы состояния приложения это только маленький шаг к полной модели ресурса. Когда модель ресурсов реализована, вы можете повторно использовать сценарии BDD, чтобы автоматически проверить, соответствует ли реализация требованиям.

В общем, методы BDD могут нам очень помочь при разработке RESTful API.