REST API определяет набор функций, к которым разработчики совершают запросы и получают ответы. Взаимодействие происходит по протоколу HTTP. Плюс такого подхода — HTTP широко распространён, поэтому REST API можно использовать почти в любом языке программирования. Минус — нет конкретного правила, как строить REST API. Вы не найдете конкретные правила, все информационные ресурсы по REST имеют рекомендательный характер.
Основные соглашения при REST API:
GET - достать без удаления, чистый read-only
POST - создать что-либо, положить, сохранить
PUT - внести изменения в что-либо, update, edit
DELETE - удалить
Вот пример простого API по вытаскиванию информации из библиотеки:
GET /books — вернуть все книгиGET /books/{id} — вернуть книгу с конкретным айдишникомGET /books/{id}/page/{number} — вернуть конкретную страницу для конкретной книгиPOST /books + request body: { id: "…", content: "…", … } — создать книгуPUT /books/{id} + request body: { content: “x”, … } — заменить книгу другой книгой либо обновитьDELETE /books — удалить все книгиDELETE /books/{id} — удалить конкретную книгу