Skip to content

Instantly share code, notes, and snippets.

@davinmsu
Last active August 29, 2015 14:15
Show Gist options
  • Select an option

  • Save davinmsu/1ffa989bc3033260c6db to your computer and use it in GitHub Desktop.

Select an option

Save davinmsu/1ffa989bc3033260c6db to your computer and use it in GitHub Desktop.
################################
### Классический REST запрос
################################
# запрос на получение объекта типа 'post' с уникальным идентификатором 123
'http://backend.url/posts/123'
# ответ, содержащий структурированную информацию по запросу:
# title - заголовок новости
# body - тело новости
# time - временная метка
# author - автор новости
# конкретное содержание ответа - тема для отдельного разговора
# здесь и далее представлен только предлагаемый формат
{title: 'title text...', body: 'body text...'}
# Запрос на получение массива объектов типа 'post'
# в количестве 10 штук,
# из раздела 'спорт',
# начиная с 5-го элемента по порядку приоритетности,
# определенной для пользователя 45,
# находящегося на станции 5,
# движущегося в направлении 1
'http://backend.url/posts?limit=10&type=sport&offset=5&uid=45&station=5&track=1'
# Ответ на запрос
[
{title: 'title text...', body: 'body text...', image: 'http://example.com/123.jpg'},
{title: 'title text...', body: 'body text...', image: ['http://example.com/121.jpg','http://example.com/124.jpg','http://example.com/125.jpg']}
]
################################
### Пакетный запрос
################################
# Пакетный запрос на получение данных, структурированных по ключам
{
geo_news: {model: 'post', limit: 10, type: 'geo'},
main_news: {model: 'post', limit: 10, type: 'main'},
news: {model: 'post', limit: 10, offset: 10},
top_post: {model: 'post', id: 105},
apps: {model: 'app', limit: 10},
books: {model: 'book', limit: 5}
}
# Ожидаемый ответ содержит те же ключи, что и запрос
{
geo_news: [
{title: 'title text...', body: 'body text...'},
{title: 'title text...', body: 'body text...'}
],
main_news: [
{title: 'title text...', body: 'body text...'},
{title: 'title text...', body: 'body text...'}
],
news: [
{title: 'title text...', body: 'body text...'},
{title: 'title text...', body: 'body text...'}
],
top_post: {title: 'title text...', body: 'body text...'},
apps: [
{title: 'title text...', body: 'body text...'},
{title: 'title text...', body: 'body text...'}
],
books: [
{title: 'title text...', body: 'body text...'},
{title: 'title text...', body: 'body text...'}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment