13.7K ·GitHub
Что это такое?
Руководство по практикам проектирования API на основе HTTP+JSON, составленное на основе работы над Heroku Platform API. Оно охватывает такие темы, как именование ресурсов, версионирование, обработка ошибок и пагинация.
Руководство по практикам проектирования API на основе HTTP+JSON, составленное на основе работы над Heroku Platform API. Оно охватывает такие темы, как именование ресурсов, версионирование, обработка ошибок и пагинация.Это библиотека или просто документация?Это письменное руководство (книга или документ), а не код, который нужно устанавливать или запускать.
Это письменное руководство (книга или документ), а не код, который нужно устанавливать или запускать.Как это почитать?Читайте онлайн на GitBook для лучшего удобства или просматривайте исходный код в формате Markdown в репозитории, начиная с таблицы содержания Summary.
Читайте онлайн на GitBook для лучшего удобства или просматривайте исходный код в формате Markdown в репозитории, начиная с таблицы содержания Summary.Это единственно правильный способ проектировать API?Нет, авторы прямо говорят, что это один последовательный, хорошо документированный подход, а не обязательно единственный или идеальный.
Нет, авторы прямо говорят, что это один последовательный, хорошо документированный подход, а не обязательно единственный или идеальный.Для кого это руководство?Для разработчиков и проектировщиков API. Изначально оно создавалось для внутренних и платформенных API Heroku, но задумано так, чтобы быть полезным любому проектировщику API на основе HTTP+JSON.
Для разработчиков и проектировщиков API. Изначально оно создавалось для внутренних и платформенных API Heroku, но задумано так, чтобы быть полезным любому проектировщику API на основе HTTP+JSON.Нужны ли предварительные знания HTTP и JSON, чтобы следовать этому руководству?Да, руководство предполагает знакомство с основами API на базе HTTP+JSON и не объясняет эти базовые вещи.
Да, руководство предполагает знакомство с основами API на базе HTTP+JSON и не объясняет эти базовые вещи.Есть ли руководство на других языках, кроме английского?Да, есть переводы, выполненные сообществом, в том числе на итальянский, упрощённый и традиционный китайский, корейский, португальский, испанский и турецкий языки.
Да, есть переводы, выполненные сообществом, в том числе на итальянский, упрощённый и традиционный китайский, корейский, португальский, испанский и турецкий языки.Зачем было создано это руководство?Оно было составлено на основе реальных решений по проектированию, принятых в Heroku Platform API, с целью добиться единообразия между API и избежать бесконечных споров о мелочах в дизайне.
Оно было составлено на основе реальных решений по проектированию, принятых в Heroku Platform API, с целью добиться единообразия между API и избежать бесконечных споров о мелочах в дизайне.What are similar projects?git-flight-rules, docker-cheat-sheet, api-guidelines, naming-cheatsheet, github-cheat-sheet, python-cheatsheet, learnxinyminutes-docs, rust-learning
git-flight-rules, docker-cheat-sheet, api-guidelines, naming-cheatsheet, github-cheat-sheet, python-cheatsheet, learnxinyminutes-docs, rust-learning