В этом руководстве мы собираемся создать REST API, используя Node.js с базой данных MongoDB. Но что такое API?
Что такое API?
API — это аббревиатура от Application Programming Interface, программного посредника, который позволяет двум приложениям взаимодействовать друг с другом. Каждый раз, когда вы используете такое приложение, как Facebook, отправляете мгновенное сообщение или проверяете погоду на своем телефоне, вы используете API.
Предварительное условие для учебника:
- Nodejs установлен в вашей системе
- Базовые знания JavaScript
- Понимание любой базы данных (реляционной/нереляционной)
Не волнуйся! Если вы не знаете всего этого в первой строке, вы узнаете их все в этом уроке.
1. Настройка проекта:
Здесь я использую код VS в качестве редактора кода и атлас MongoDB для хранения всех данных. Вся структура проекта должна выглядеть так:
Создайте папку в своей системе и назовите ее «API». Вы можете назвать его как хотите. Откройте эту папку в редакторе кода и перейдите в терминал.
Внутри вашего типа терминала
“npm init”
Команда «npm init» инициализирует проект и создает файл package.json.
После этого нам нужно установить Express.js и все остальные зависимости для проекта.
Снова введите в терминале следующее:
npm install express dotenv mongoose body-parser cors
Таким образом, наш сервер будет работать с экспрессом, а dotenv позволяет вам отделить секреты от вашего исходного кода. Mongoose — это библиотека моделирования объектных данных (ODM) для MongoDB и Node.js. Он управляет отношениями между данными, обеспечивает проверку схемы и используется для перевода между объектами в коде и представлением этих объектов в MongoDB. Модуль body-parser анализирует данные в формате JSON, буфера, строки и URL-адреса, отправленные с использованием запроса HTTP POST. CORS расшифровывается как Cross-Origin Resource Sharing. Это позволяет нам ослабить безопасность, применяемую к API.
А теперь установим nodemon, поэтому набираем в терминале:
npm install -g nodemon
Модуль nodemon — это модуль, который разрабатывает приложения на основе node.js, автоматически перезапуская приложение узла при обнаружении изменений файла в каталоге.
После установки добавьте следующее в раздел script вашего файла package.json:
После того, как вы все установили, перейдите в файл package.json и проверьте раздел зависимостей. Должно получиться так, версии могут отличаться.
2. Настройка сервера:
Давайте создадим наш самый первый сервер. Создайте файл с именем server.js и напишите следующий код:
Создайте имя файла «.env» и поместите в него этот код.
Здесь мы добавили номер порта и URL-адрес подключения MongoDB. Позвольте мне рассказать вам, как вы можете получить URL-адрес MongoDB в первую очередь.
3. Настройка базы данных:
Перейдите в MongoDB Atlas и создайте кластер. Настройка может занять несколько минут. После этого нажмите подключить, а затем Подключить ваше приложение. После этого вы получите URL-адрес подключения к MongoDB.
4. Настройка модели:
Для каждых данных в базе данных нам нужна модель, с помощью которой мы можем загружать и поддерживать правильные данные. Здесь мы используем mongoose для создания модели базы данных.
5. Настройка маршрутов:
Создайте папку с именем «Маршруты» внутри основного каталога, создайте один файл с именем «todo.js», в котором будут установлены все маршруты. Теперь эти строки в вашем файле todo.js внутри папки маршрутов.
В этом файле мы создали 4 маршрута для получения всего списка задач, создания задачи, обновления определенной задачи и удаления одной задачи. Вся бизнес-логика будет идти в раздел контроллера.
Каждый входящий запрос будет идти к определенным методам контроллера.
6. Настройка контроллеров:
Контроллер — это основная часть приложения, в которой будет находиться вся ваша бизнес-логика. Нам нужны определенные логические блоки для разных методов.
Итак, мы готовы к работе с конечными точками API. Теперь самая важная часть — это то, где мы собираемся тестировать API. Перед этим откройте терминал и запустите «npm start», чтобы запустить приложение.
7. Почтальон:
Для тестирования API мы используем Postman. Вы можете скачать настольную версию или использовать ее в браузере.
8. Тестирование API:
(а). Вставьте задачу:
URL-адрес: https://localhost:3000/api/todos/
Метод: ПОСТ
Убедитесь, что ваш заголовок настроен на это:
Теперь попробуйте добавить к нему задачу и нажмите ОТПРАВИТЬ.
И мы должны увидеть это в вашем почтальоне:
Это означает, что данные вставлены успешно. Если вы все еще хотите проверить это из базы данных, вы найдете это:
(b) Список задач:
URL-адрес: https://localhost:3000/api/todos/
Метод: ПОЛУЧИТЬ
Таким образом, мы можем получить весь список задач.
(c) Обновите определенные задачи:
URL-адрес: https://localhost:3000/api/todos/update/XXY667e48c13e3ae5d7XXXX
Метод: ПОЛОЖИТЬ
Вам нужно передать конкретный идентификатор в конце URL-адреса и передать обновленное значение задачи в данных формы.
(d) Удалить определенные задачи:
URL-адрес: https://localhost:3000/api/todos/delete/61c369c773923cf617beba60
Метод: УДАЛИТЬ
Точно так же, как работает API обновления, нам нужно передать конкретный идентификатор в конце URL-адреса и сделать метод удаления.
Так вот оно. Мы успешно создали REST API, используя Node.js, Express.js и MongoDB. Надеемся, что это руководство поможет вам понять основную концепцию каждого REST API.
Большое спасибо, что дочитали до конца. Вы можете связаться со мной, если вам понадобится помощь.
Интернет: https://ankandas.netlify.app
Instagram: https://www.instagram.com/ankaninperson /
GitHub: https://github.com/Ankan982
Больше контента на plainenglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Получите эксклюзивный доступ к возможностям написания и советам в нашем сообществе Discord.
