Подсказка: макет API REST с использованием json-сервера

Чтобы проверить наш фиктивный API, мы можем использовать curl для выполнения HTTP-запроса:

 $ curl -X GET "http://localhost:3000/movies"

Это вернет список всех фильмов, которые у вас есть на этом сервере. В приведенном выше случае вы получите два фильма. Теперь, чтобы получить фильм с идентификатором 1, просто укажите идентификатор в конце URI: http: // localhost: 3000 / movies / 1.

Чтобы добавить фильмы на сервер, вы можете отправить запрос POST в API с подробностями фильма. Например:

 $ curl -X POST -H "Content-Type: application/json" -d '{
  "id": 3,
  "name": "Inception",
  "director": "Christopher Nolan",
  "rating": 9.0
}' "http://localhost:3000/movies"

Это ответит новыми данными фильма. Чтобы убедиться, что запись была успешно добавлена, давайте попробуем получить фильм с идентификатором 3:

 $ curl -X GET "http://localhost:3000/movies/3"

Точно так же вы можете использовать другие HTTP-глаголы, такие как PUT и DELETE, для доступа и изменения данных на этом сервере. По соглашению POST используется для создания новых объектов, в то время как PUT используется для обновления существующих объектов.

Примечание. Для запросов PUT, POST и PATCH должен быть установлен заголовок Content-Type: application/json

Характеристики

json-server предоставляет множество полезных функций для макета API, которые вам нужно вручную построить на бэкэнде. Давайте рассмотрим некоторые из этих функций:

фильтры

Вы можете применить фильтры к вашим запросам, добавив их в URI в виде строки запроса. Например, если вы хотите получить подробную информацию о фильме с именем «Касабланка», вы можете отправить запрос GET на ваш URI ресурса, добавив знак вопроса (?), За которым следует имя свойства, по которому вы хотите выполнить фильтрацию, и его значение:

 $ curl -X GET "http://localhost:3000/movies?name=Casablanca"

Вы также можете объединить несколько фильтров, добавив амперсанд (&) между различными фильтрами. Например, если мы также хотим фильтровать по идентификатору в приведенном выше примере, мы могли бы использовать:

 $ curl -X GET "http://localhost:3000/movies?name=Casablanca&id=2"

операторы

API также предоставляет логические операторы для упрощения фильтрации. Вы можете использовать _gte_lte У вас также есть _ne

Например, если вам нужны все фильмы, рейтинг которых больше или равен 9:

 $ curl -X GET "http://localhost:3000/movies?rating_gte=9"

Обратите внимание, что вы можете объединить несколько операторов, используя знак амперсанда. Таким образом, чтобы получить все фильмы с рейтингом от 5 до 7, вы должны сделать следующий запрос:

 $ curl -X GET "http://localhost:3000/movies?rating_gte=5&rating_lte=7"

пагинация

В реальном сценарии вы будете иметь дело с большим количеством данных. Загрузка этих данных в куски размера укуса проста благодаря встроенной поддержке пагинации в json-сервере, которая фиксируется на уровне 10 элементов на странице.

 $ curl -X GET "http://localhost:3000/movies?_page=3"

 $ curl -X GET "http://localhost:3000/movies?_sort=name&order=DESC"

 $ npm install faker

 var faker = require('faker');

var db = { movies: [] };

for (var i=1; i<=1000; i++) {
  db.movies.push({
    id: i,
    name: faker.random.words(),
    director: faker.name.firstName() + ' ' + faker.name.lastName(),
    rating: Math.floor(Math.random()*100+1)/10
  });
}

console.log(JSON.stringify(db));

 $ node fake-data-generator.js > db.json