Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1.44 KB

README.md

File metadata and controls

21 lines (17 loc) · 1.44 KB

Pokemon REST API

http://pokemon---api.herokuapp.com

Запуск сервера не привязан к определенному URL, по-умолчанию на локальной машине URL - http://localhost:port, где port берётся из переменных окружения PORT или LOCAL_SERVER_PORT. Если данные переменные не определены, то порт по-умолчанию устанавливается - 3000.

Данный API с помощью GET-запросов поддерживает следующие команды:

  1. /api/v1/pokemon - получить список всех покемонов
  2. /api/v1/pokemon?limit=10 - ограничить получаемый список 10 элементами
  3. /api/v1/pokemon?offset=10 - начать формировать список, начиная с 10 элемента
  4. /api/v1/pokemon/:name - получить покемона по полю name
  5. /api/v1/berry - получить список всех ягод
  6. /api/v1/berry?limit=10&offset=10 - аналогично с предыдущими query string запросами
  7. /api/v1/berry - получить ягоду по полю id

Установка и запуск

Установка со всеми зависимостями происходит с помощью команды npm i

Запуск node index.js