Рубрики
Без рубрики

Создайте API REST с помощью node.js: Design & Plan Your API

Всем привет! Добро пожаловать в первую статью захватывающей новой серии под названием «Давайте создать node.js r … Tagged с узлом, Restapi, Mongodb, JavaScript.

Всем привет! Добро пожаловать в первую статью захватывающей новой серии под названием Давайте построим node.js rest api Анкет В этой серии я буду проходить пошаговое руководство о том, как вы можете планировать, разработать и создать свой собственный API REST с помощью Node.js!

Прежде чем мы начнем …

Некоторые предпосылки, которые вам нужно следовать:

  • Новичок в промежуточном знании в JavaScript
  • Основное понимание того, что такое API Rest
  • Основное понимание внутреннего программирования и node.js

Прочитайте мои статьи о REST APIS и Бэк-энд программирование Если вам нужно быстрое освежение.

Берегись! Некоторые инструменты, которые мы будем использовать:

  • Visual Studio Code или любой текстовый редактор
  • Почтальон
  • Node.js и Express
  • Mongodb Атлас

На данный момент вам просто нужно установить текстовый редактор на вашем компьютере. Я объясню, как установить остальное в этой серии.

Шаг 1: Планирование нашего T-API

Для этого урока мы будем делать простой API для чая (так случайно, что я знаю). Я называю это T-API Потому что это звучит как «чайный API».

Чтобы спланировать API, мы должны сначала понять, что мы хотим, чтобы он сделал. Мы можем записать Пользовательские истории Чтобы помочь нам определить, что нам нужно в нашем дизайне API.

Наши истории пользователей T-API

  1. Я могу создать новый чайный объект и добавить его в базу данных
  2. Я могу получить весь чай из базы данных
  3. Я могу удалить весь чай в базе данных
  4. Я могу получить один чай, запрашивая его название
  5. Я могу опубликовать комментарий к одному чаю
  6. Я могу удалить один чай из базы данных

Наш чайный объект

Основываясь на наших пользовательских историях и то, как мы хотим использовать API, мы можем составить образцы чайного объекта, который может вернуть API. Это помогает нам решить, какие свойства включать в объект в начале стадии создания этого API. Итак, для T-API может выглядеть чайный объект:

{
    "name": "Jasmine Tea",
    "image": "an image file url",
    "description": "Jasmine tea (茉莉花茶) is tea scented with the aroma of jasmine blossoms.",
    "keywords": "aromatic, china, sweet",
    "origin":"China",
    "brew time": 2,
    "temperature": 80,
    "comments": []
}

Шаг 2: Проектирование структуры для T-API

Способ создания API – это визуализация его Маршруты и Методы запроса Анкет

Теперь, когда мы поняли, что мы хотим, чтобы T-API сделал для нас, мы можем придумать такой дизайн, как это:

/чай Отображает весь чай ПОЛУЧИТЬ
/чай Создает новый чай СООБЩЕНИЕ
/чай Удаляет весь чай УДАЛЯТЬ
/чай/: имя Отображает конкретный чай, учитывая его название ПОЛУЧИТЬ
/чай/: имя Добавляет комментарий к конкретному чаю, учитывая его название СООБЩЕНИЕ
/чай/: имя Удаляет конкретный чай, учитывая его название УДАЛЯТЬ

Хорошо, мы запланировали и разработали наш T-API, давайте начнем с настройки проекта!

Шаг 3: Установите Node.js и NPM

Скачать node.js (с npm) по адресу: https://nodejs.org/en/download/

После того, как он установлен, чтобы проверить, есть ли это там, перейдите к своей командной строке:

node -v
npm -v

Шаг 4: Инициализировать проект

Создайте новый файл проекта и в корневом каталоге, инициализируйте NPM, запустив следующий код в командной строке:

npm init

Ответьте на следующие вопросы и Package.json Файл будет создан.

Шаг 5: Установите выражать

Давайте установим Экспресс и сохранить его в нашем Package.json Бег:

npm install --save express

Шаг 6: Создать сервер

Теперь мы создаем Server.js Файл в корневом каталоге нашего проекта, чтобы позаботиться о Бэк-Энд. Во -первых, мы должны создать приложение Express с:

const express = require("express");
const app = express();

Теперь мы можем добавить код после:

app.use(express.json()); // parses incoming requests with JSON payloads

Затем, под ним, наш слушатель, чтобы попросить наш сервер прослушать запрос.

const listener = app.listen(process.env.PORT || 3000, () => {
    console.log('App is listening on port ' + listener.address().port)
})

По умолчанию мы хотим прослушать на порту 3000. Однако в тех случаях, когда номер порта обозначен из переменной среды, приложение будет прослушать Process.env. Порт .

Попробуйте тестовый запуск!

Итак, теперь, когда у нас есть настройка Server.js, давайте попробуем запустить сервер, введя

node server.js

в командную строку. Если это работает, вы должны увидеть, как консоль выводит сообщение, сообщающее вам, какой порт он слушает.

Это все сейчас!

Спасибо за прочтение первой статьи серии. Технически, я могу написать о создании API REST в 1 статью, но это будет слишком долго, и мне придется оставить много важных деталей, которые могут запутать новичков кода.

Я надеюсь, что это было полезно для вас. Обязательно Мол, поделитесь этой статьей и следите за обновлениями Для следующей части, где мы начнем создавать наши маршруты и настраивать нашу базу данных в Mongo Atlas! А пока, пожалуйста, Задайте любые вопросы В комментариях ниже и прочитайте о структуре/концепциях/технологиях в этой статье, чтобы ускорить ваше обучение. До следующего раза, ура!

Глоссарий

Вот некоторые потенциально незнакомые слова, которые я использовал в этой статье. Не стесняйтесь читать медленно и читать предложенные статьи для получения дополнительной информации.

Пользовательские истории

Согласно Википедия Пользовательская история – это неформальное, естественное описание одного или нескольких функций программной системы. Пользовательские истории часто написаны с точки зрения конечного пользователя или пользователя системы.

маршруты

Маршруты представлены как URI в API REST. Например, маршрут индекса для API – «/». На нем будут построены другие маршруты, такие как «/имена» для маршрута, который возвращает все имена или «/страницы» для того, кто возвращает все страницы. Читайте по базовой маршрутизации Здесь Анкет

Методы запроса

Методы запроса относятся к методам HTTP, которые определяют желаемое действие, которое браузер хочет сделать с сервером. Прочитайте мою статью о Основы HTTP -запросов Больше подробностей.

выражать

Express-это веб-фреймворк для Node.js, чтобы обеспечить легкую и надежную маршрутизацию для продвижения в среде. Он будет использоваться для создания наших маршрутов и обработки наших HTTP -запросов и любых промежуточное программное обеспечение для нашего API. Вы можете прочитать больше в его документации Здесь Анкет

промежуточное программное обеспечение

Промежуточное программное обеспечение по существу относится к программному обеспечению, которое находится между запросами на стороне клиента и ресурсом на стороне сервера. Он обрабатывает данные, предоставляет управление API, услуги обмена сообщениями, а также аутентификацию. Для получения дополнительной информации прочитайте Здесь Анкет

Дальнейшее чтение

Оригинал: “https://dev.to/lo_victoria2666/build-a-rest-api-with-node-js-design-plan-your-api-2ocm”

Читайте ещё по теме: