Что такое такое rest api?

Question

[Egorus]

Что такое такое rest api ? Объясните, пожалуйста, понятными словами. Википедия, увы, не смогла ответить.

Специалист по rest api должен разбираться в, например, api vk ? Или это разные вообше вещи? В чем разница?

Большое спасибо.

Comments

[NeKt0]

Это никто толком не может объяснить, чтобы сразу стало понятно. Увы.

Answer 1

[Андрей Ежгуров]

API социальных сетей - это вполне типичные примеры реализации REST API.

REST (RESTful) - это общие принципы организации взаимодействия приложения/сайта с сервером посредством протокола HTTP. Особенность REST в том, что сервер не запоминает состояние пользователя между запросами - в каждом запросе передаётся информация, идентифицирующая пользователя (например, token, полученный через OAuth-авторизацию) и все параметры, необходимые для выполнения операции.

Всё взаимодействие с сервером сводится к 4 операциям (4 - это необходимый и достаточный минимум, в конкретной реализации типов операций может быть больше):
1. получение данных с сервера (обычно в формате JSON, или XML)
2. добавление новых данных на сервер
3. модификация существующих данных на сервере
4. удаление данных на сервере

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

Для каждого типа операции используется свой метод HTTP-запроса:
1. получение - GET
2. добавление - POST
3. модификация - PUT
4. удаление - DELETE

Т.е. :

GET-запрос /rest/users - получение информации о всех пользователях
GET-запрос /rest/users/125 - получение информации о пользователе с id=125
POST-запрос /rest/users - добавление нового пользователя
PUT-запрос /rest/users/125 - изменение информации о пользователе с id=125
DELETE-запрос /rest/users/125 - удаление пользователя с id=125

Comments

[Антон Сашнин]

Также, есть 5-ый INDEX (он же HEAD, LIST)

[Андрей Ежгуров]

А ещё есть PATCH - для небольших изменений данных. Я сознательно перечислил только минимум.

[Евгений Петров]

@antonsash интересно, а OPTIONS используют в RESTful?

[Антон Сашнин]

@Petroveg точно сказать не могу, 5 методов думаю уже достаточно.

[Андрей Ежгуров]

Если метод не поддерживается, сервер должен вернуть 405 со списком допустимых методов. Так что OPTIONS добавить элементарно. Но зачем?

[Иван Акулов]

@eandr_67 Извините, оффтоп: а какой формат списка методов? Произвольный или чётко задан?

[Андрей Ежгуров]

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

Лично я использовал запросы вида:

/<версия>/<контроллер базовой сущности>[/][/<операция над подчинённой сущностью>][/]

Т.е. если пользователь пишет сообщение пользователю 340, то запрос будет:

POST /v20/users/340/letter

А если удаляет из переписки сообщение id 12345, то:

DELETE /v20/users/letter/12345

[Андрей Ежгуров]

Поправка:

/<версия>/<контроллер базовой сущности>[/<id базовой сущности>][/<контроллер подчинённой сущности>[/<id подчинённой сущности>]]

[Андрей Ежгуров]

Если же речь о методах HTTP, то проще на wiki прочитать: https://ru.wikipedia.org/wiki/HTTP

[Сергей Протько]

@gxoptg вообще есть такая штука как URI, спецификация которой регламентирует рекомендации.

@Petroveg OPTIONS - крайне редко. Во всяком случае кроме как для поддержки CORS в основном.

@eandr_67 ну вот опять же. Версию писать это уже не restfull. Либо в заголовки указывать либо еще как.

Естественно что никто никогда не соблюдает все правила REST. Просто потому что это глупо. Ответы на POST запосы частеньо содержат тело, что бы не делать второго запроса к серверу, люди длают частичные обновления через PUT а нечерез PATCH. Если метод создает связь - частенько делают через POST а не через LINK.

А еще есть такие штуки как HATEOAS и ее аналог для json - jsonapi.org (ну и просто список нинков в формате json а не xml).

Словом... REST это хорошо, но нужно еще думать как будет эффективнее/проще реализовать.

[Сергей Протько]

blog.2partsmagic.com/restful-uri-design - вот неплохая подборка рекомендаций, если кому интересно.

[Sergey Romanov]

А вот инструментик для создания паблик API с удобной документацией и если надо оплатой за запросы елси кому надо. Может не совсем в тему, но мне очень понравилась идея. Даже создал там 2 пиватных апишки для приложений. Удобно делится с коллегами. Например кто то пришет на Андроид (чего я вообще не знаю как делать) просто дал ему ссылочку и у него есть все что нужно. И защита там встроена. Со своей сотроны только нужна проверка что запрос пришел с этой службы.

https://www.mashape.com/

[Devid]

Может кто то скинуть пример реализации на php?

[Тайгер]

Извините, а где описано, что REST API должно именно так использовать GET,POST,PUT,DELETE ?
Вроде сам идеолог REST API такого не предлагал.

[Андрей Ежгуров]

Тайгер, то, что предлагал идеолог - это очень общие принципы организации взаимодействия, никак не связанные с интернетом. Но у нас протокол HTTP, обладающий вполне конкретными свойствами. И организовывать взаимодействие приходится в рамках этого протокола.

Потому за немалое кол-во лет выработалась схема, максимально удобно накладывающая принципы REST на реалии HTTP.

[Михаил]

Это называется объяснили простыми словами

[Михаил]

Ничего не понял, что такое рест апи

[Андрей Ежгуров]

Михаил, а остальные как-то поняли. С чего бы это? Если я напишу, что Rest API является самым популярным способом организации API через HTTP[S], тебе станет легче?

[Михаил]

Не особо :) я хочу понять, если я делаю сайт на Вордпресс, то я могу, используя рест апи , создавать например произвольные типы записей, различные меню и т.д. Как именно это делается в Вордпресс ?

[Андрей Ежгуров]

Михаил, так бы и говорил, что тебе нужно API WP. По нему есть подробная документация: https://developer.wordpress.org/rest-api/reference/

И нет, таксономии и типы записей стандартными методами ты можешь только читать, но не создавать: их создание (также, как и создание меню) требует написания php-кода в файле functions.php твоей темы. Впрочем, никто не мешает тебе написать собственные методы API, реализующие необходимый функционал.