Стандарты обмена по REST?

Question

[Ivanko]

Доброго!

Необходимо написать API (JSON) для сохранения данных (POST) на PHP (Slim/Phalcon), само собой необходимо чтобы для тех кто будет Постить данные чтобы использование АПИ было максимально понятным - то как это происходит обычно с другими сервисами.

Существуют ли определенно-сформированные стандарты и гайдлайны обмена данными по RESTful?
К примеру наименования полей, методов, формат передачи определенных значений, способы аутентификации, версионирование и тд?

Чтото типа YML (Yandex Market Language).

Если да то что можно почитать? Возможно есть сервисы которые могут помочь в этом?

Благодарю!

Answer 1

[⚡ Kotobotov ⚡]

сфера еще молодая и каждый пишет как ему удобнее, хотя индустрия пытается внедрять разного рода стандарты (пока на уровне рекомендаций)
json-schema.org - например
обычно такие стандарты принимают внутри какой-либо отрасли, для того чтоб иметь одинаковые интерфейсы внутри разных продуктов. Вот пример fhir стандарт - в медицине.
------
есть о общие рекомендации по поводу формирования АПИ на основе здравого смысла, когда например ответ заворачивается в обьект, у которого еще есть поля например с пагинацией, ссылками на шаг назад, и шаг вперед, возможно каким-то сообщением для пользователя, или там например указанием сколько всего обьектов которые мы обходим и тд.
По аутентификации есть, например рекомендация ключ не передавать в строке браузера, а передавать в заголовке запроса, тк иначе он будет сохранятся в истории браузера, ну и при переходе на другой сайт, может тоже быть засвечен в источнике перехода.

Comments

[Сергей Горностаев]

JSON Schema это способ валидации данных в формате JSON, а не стандарт их структуры.