В настоящее время частой практикой является взаимодействие вашего приложения или веб-сайта с другими службами для работы и наилучшего функционирования. У вас могут быть определенные клиенты Reddit, которые официально созданы не людьми Reddit, а сообществом. На Discord существуют всевозможные боты или сервисы, которые не созданы на основе Discord, но они без проблем работают с Discord до такой степени, что кажется, что они являются частью разногласий. Как все это происходит?

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

Теперь, как эти API могут быть чем угодно, они могут быть написаны для выполнения любой задачи, но в этой статье API, которые являются основной целью, являются веб-API. Веб-API - это подтип API, которые предназначены для доступа через Интернет или Интернет. Эти веб-API традиционно писались на основе архитектуры SOAP, а в настоящее время они пишутся с использованием GRAPHQL, gRPC и нескольких других растущих технологий, но существует практика, которая привела к огромному росту веб-API и упростила разработку даже для людей, которые не делают это. У меня нет знаний, чтобы их создавать.

Давайте сами напишем его.

Мой любимый технический стек, который я люблю писать API, - это Node.js и Restify.

Теперь есть несколько способов создания REST API, но мне нравится работать с Restify, так как для него так легко написать код, а также JSON кажется родным при написании кода на JavaScript.

Начнем с процесса кода.

Во-первых, вы должны убедиться, что Nodejs установлен в вашей системе, и вы можете сделать это, перейдя на https://nodejs.org/en/download/ и следуя инструкциям по загрузке и установке.

Теперь, чтобы писать приложения в Nodejs, вам нужно создать проект, а внутри определения проекта, то есть package.json, будут определения того, как ваши проекты должны быть построены и запущены, и какие разные сценарии у вас могут быть. Пример package.json выглядит так.

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

Итак, теперь в этих двух строках мы установили зависимость проекта и зависимость режима разработки проекта. Nodemon - это инструмент, который при использовании будет отслеживать весь наш проект на предмет изменений в коде, и как только мы внесем эти изменения, он обновит наш сервер, и хорошо использовать Nodemon при разработке API.

Теперь, когда мы настроили наши зависимости, самое время написать код. Итак, создайте файл index.js в корне вашего проекта, и мы напишем код, который запустит http-сервер на каком-то порту и на котором мы сможем начать построение REST API.

Теперь в этих трех строках мы загрузили зависимость restify, определили порт и создали сервер с помощью restify. В строке, где определен порт, вы можете увидеть, что мы написали process.env.PORT, он загружает имена переменных окружения PORT, иначе, если он отсутствует, потребуется 3000. После того, как мы это сделаем, давайте добавим еще код.

После того, как мы создали сервер, пора написать код, чтобы сделать его простой конечной точкой, возвращающей hello world. Как видите, сделать это просто, я сделал это в приведенном выше файле. Функция _server.get () _ используется для получения функций через конечную точку, и здесь она принимает два параметра

  1. ‘/’ - Путь к конечной точке
  2. (resquest, response, next) = ›{} - функция для возврата ответов.

Теперь мы пишем для корня api, поэтому мы выбрали путь просто '/', вы можете выбрать любой путь по своему усмотрению, например '/ api /' или '/ api / v1 /', и мы вернули простой Hello world в response.send (), поэтому он вернет именно это, как только получит запрос в корневой конечной точке.

После этого мы просто инициализировали и заставили сервер работать на порту, который мы ранее определили, и определили лямбда-функцию, которая представляет собой обратный вызов, который запускается, если сервер был успешно размещен. Теперь, если вы выполните простую команду в своем терминале, например node index.js, он должен запустить сервер и сказать, что прослушивает порт 3000 или любой другой порт, если вы определили переменная среды PORT. Когда вы попадаете в корневой каталог сервера из своего браузера, вы должны увидеть Hello world.!.

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