Описание тега json-api

"JSON API" - это стандарт для создания API в JSON. Если вы когда-либо спорили со своей командой о том, как должны быть отформатированы ваши ответы JSON, JSON API - ваше оружие против велосипеда.

Кроме того, клиенты, построенные на основе JSON API, могут использовать преимущества его функций по эффективному кэшированию ответов, иногда полностью устраняя сетевые запросы.

Следуя общим соглашениям, вы можете повысить продуктивность, воспользоваться универсальными инструментами и сосредоточиться на самом важном: на вашем приложении.

Вот как выглядит JSON API (в стиле ID):

{
  "posts": [{
    "id": "1",
    "title": "Rails is Omakase",
    "links": {
      "author": "9",
      "comments": [ "5", "12", "17", "20" ]
    }
  }]
}

и в стиле URL:

{
  "posts": [{
    "id": "1",
    "title": "Rails is Omakase",
    "links": {
      "author": "http://example.com/people/9",
      "comments": "http://example.com/comments/5,12,17,20"
    }
  }]
}

JSON API также охватывает создание и обновление ресурсов, а не только ответов.

Более подробную информацию можно найти на домашней странице проекта.