Simple-API
Назначение
Веб-сервис предназначен для создания учебных проектов с элементами сетевого взаимодействия. На примере простых API рассматриваются следующие технологии и понятия:
- HTTP-протокол, его методы (GET, POST, PUT, DELETE), заголовки ответа, статус ответа;
- JSON-формат ответа, структура данных “словарь”, ключ-значение;
- URL-запросы с параметрами, GET-параметры запроса;
- CRUD-приложения.
Основные функции
После развёртывания, становятся доступны следующие API:
8 Ball - возвращает случайный ответ “Магического шара”;
Число чётное? - помогает определить, чётное ли число;
Холст - хранение координат и цвета точки на общем холсте;
QR-код - создание qr кода по заданному тексту.
Доступ к интерактивной документации можно получить по адресу:
https://БАЗОВЫЙ_URL/docs
или
https://БАЗОВЫЙ_URL/redoc
С помощью документации можно узнать путь для доступа к API и применяемый HTTP-метод:
узнать, как должно выглядеть тело запроса:
и каким будет ответ сервера:
Нажав на кнопку Try it out
можно отправить тестовый запрос напрямую из документации.
Ссылки
Ссылка на репозиторий с исходным кодом
Для размещения собственной копии API можно использовать сервис render.com. Создайте аккаунт на сервисе и перейдите по следующий ссылке, чтобы автоматически создать копию веб-сервиса на своём аккаунте.