RESTful API Design Document

Question

Как часть моей домашней работы, я должен сделать это:

Вам нужно отправить нам дизайн документ о том, как вы бы реализовать restfull API для интернет-магазина. Он должен поддерживать добавление, удаление, редактирование и поиск продукта. Вы можете предположить все, но не забудьте их документировать. Убедитесь, что вы рассматривали такие вещи, как аутентификация (только зарегистрированные пользователи могут добавлять/просматривать/редактировать/удалять элементы). Вы создаете API для мобильного разработчика, который будет использовать его для создания мобильного приложения. Было бы здорово, если бы вы могли также включить некоторые примеры сценариев вместе с ожидаемыми объектами запроса/ответа.

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

Должен ли я предоставить код для API, как на этой веб-странице, http://coreymaynard.com/blog/creating-a-restful-api-with-php/

или я не имею в коде, но я должен объяснить выполнение кода на английском языке?

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

Я понимаю ОТДЫХ, но я просто не уверен, что этот вопрос попросил меня сделать?

Что такое проектный документ, для RESTFUL API.

Answer 1

Когда бизнес, дизайн документа обычно означает, что вы планируете технический процесс/структуру функции, и вы объясняете преимущества и возможные подводные камни и т. Д., Действительно сложно сказать, действительно ли ваш учитель говорит о том, Дизайн API в этом отношении. в основном, он, вероятно, хочет, чтобы вы перечислили все URL-адреса API и объяснили, какой метод для каждого, и каковы их функции.

шансы, если он означает RESTful дизайн апи в последнем значении, то его, вероятно, подобно тому, как Rails отображает их маршруты: