Что такое Axe API?

Axe API — это самый быстрый способ создать Rest API, определяя только модели баз данных и отношения между ними. Он построен на Knex.js, и это отличный шаблон активных записей. С другой стороны, у вас есть еще одна знакомая вещь, Экспресс.

Axe API предоставляет вам возможность отделить ваши общие задачи для создания API от вашей бизнес-логики. Axe API ожидает, что определения модели проанализируют вашу структуру маршрутизации. После того, как вы создали свои модели и их отношения между ними, API Axe может обрабатывать все известные запросы API. Создание API с 5 таблицами занимает почти 15 минут.

Короче говоря, Axe API выполняет три основные функции;

  • Анализирует ваши модели и их отношения для создания маршрутов.
  • Обрабатывает все HTTP-запросы.
  • Отделите свою бизнес-логику от лучших практик API.

Создание нового проекта

Вы можете создать новый проект axe-api в вашей локальной среде разработки;

После этого ваш API готов к работе!

Вы можете получить доступ к API через URL;

Создание таблицы базы данных

Чтобы выполнить миграцию, во-первых, вам необходимо установить интерфейс командной строки Knex в вашей среде разработки;

Теперь вы можете создать новый файл миграции;

В папке «migrations» вы можете увидеть файл миграции. Давайте изменим его содержимое следующими кодами;

Для реализации изменений необходимо выполнить следующие команды;

Ваша таблица базы данных готова.

Создание модели

Модели — это сердце Axe API. Но это не простые модели ORM. Они больше, чем это.

Давайте создадим новый в каталоге "app/models".

Как видите, это очень простой файл. Вы вряд ли нам поверите, но API готов к использованию. Чтобы проверить это, перейдите в браузере по следующему URL-адресу;

http://локальный:3000/api/пользователи

Вы увидите следующий результат;

Если вы видите этот результат в своем браузере, это означает, что вы создали простой API, определив простой файл модели!

Создание пользователя

Чтобы создать пользователя, вы должны определить, какие поля могут быть отправлены клиентами. Для этого вы должны добавить в файл модели следующий геттер;

После этого API готов к обработке POST-запросов. Вы можете использовать следующую команду, чтобы добавить новую запись;

Пагинация пользователей

Вы можете использовать следующий запрос для разбиения на страницы всех пользователей;

http://локальный:3000/api/пользователи

Получение пользователя

Вы можете использовать следующий запрос для получения записи с помощью первичного ключа

http://localhost:3000/api/users/1

Обновление пользователя

Вы можете использовать следующий запрос curl для обновления записи;

Удаление пользователя

Вы можете использовать следующий запрос curl для удаления записи;

Краткое содержание

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

В этом уроке я просто попытался показать вам, как легко создать простой CRUD API. Конечно, это очень простой пример, который не охватывает все сценарии реальной жизни. Но я гарантирую, что Axe API — мощный инструмент для проектов на основе API.

Вы можете найти весь проект в репозитории GitHub;

https://github.com/ozziest/simple-crud-axe-api-example

Узнать больше

Если вы хотите углубиться в API Axe, вы можете использовать следующие документы;