Ключовы ўстаткументы для інжынераў з інтэграціі API у Node.js

Стварэнне API ёсць толькі частка всей роботы.

Інжынеры, які фактычна з’ўязуюць системы межаўсобна, прасвятляюць большую частку свога часу на перакананне ў правільнай працэ выходных тачкаў, аналіз дакументацыі, падключэнне зовнішніх служб і перадачу даных туды-сюды межаў разных платформ.

Хорашая новына ў тым, што для гэтага не трэба великог набору інструментаў.

Якша опанаваўчы чатыры конкрэтныя інструменты, вы вже будете адпавядаць тым ваказанням, якія ставяюць большасць компаній да разработчыкаў, якія спецыялізуюцца на інтеграцыі.

1. Postman: ваш асновны інструмент для тэставання API

За дзеякі час до таго, як пачынаецца напісанне коду, команды зазвычай пераканваюцца, што API працуе правільна, выкарыстоўваючы Postman.

Можна супакоўвацца, што гэта спецыялізаваны прыглядчык, створанный для взаімадзеяння з API.

Postman дазволяе вам:

• Выканаць запыты типу GET, POST, PUT і DELETE
• Пройсці паэтапна аутентыкацыю
• Дадаць ключы API і токены JWT да запытоў

Зберагаць калекцыі запитоў для падальшага выкарыстання

Раздаваць гэтыя запиты ўсередине каманды

Ствараць аўтаматызаваныя тэсты для вашых канцэнтраў

Спадзяймося, вы хочаце пераканацца ў правільнасці маршрута для заходжання:

POST http://localhost:3000/api/login
Content-Type: application/json

{
  "email": "john@example.com",
  "password": "123456"
}

Адпаведзь можа выглядаць так:

{
  "token": "eyJhbGc..."
}

Адна з выдатных можлівасцей Postman — падтрымка зменных сяродавішча:

{{baseUrl}}/api/login

Гэтае налаштаванне дазволяе перыходзіць между локальнымі, працоўнымі та продакшн-серверамі без прабывання перапісваць што-небудзь.

Інжынерныя каманды постаўляюцься на Postman падчас адлучэння проблем з інтеграцыямі або пераканацься ў API трэціх сторон пры ўключэнні іх у проект.

2. Swagger і OpenAPI: дакументы, якія розробнікі насправды чытаюць

Уявіце, што вы пачынаеце працаваць у компаніі, якая адрабатвае сотні API.

Працаваць з кодам, каб з’ясаваць, што робіць кожны канцэнтр, проста не будзе эфектываў.

Гэта сама проблема, якую рашчыляюць спефікацыі OpenAPI і Swagger UI.

Ёсь калі можа выглядаць простая вызначэння OpenAPI:

openapi: 3.0.0
paths:
  /users:
    get:
      summary: Get all users
      responses:
        '200':
          description: Success

Swagger берае такія вызначэння і ператварае іх у доступную, інтэрактыўную документацыю, якая дазволяе разработчыкам:

• Аналізаваць доступныя канцэнтры
• Бачыць прыклады запитоў
• Пераканацца, якая аутэнтыкацыя трэба
• Адкрываць вызовы API працоўна з браузера

Да адключэння Swagger да прыкладу аплікацыі Express патрэбны толькі калькі крокаў. Перш за ўсё, установіце пакеты:

npm install swagger-ui-express yamljs

Потым ўсё налацюйце:

const swaggerUi = require("swagger-ui-express");
const YAML = require("yamljs");
const swaggerDocument = YAML.load("./swagger.yaml");

app.use(
  "/api-docs",
  swaggerUi.serve,
  swaggerUi.setup(swaggerDocument)
);

Наявнасць документацыі, яю можна пераглядаць, значным чынам скрачвае час адклікання і спрыяе кращай сааверцы ў командах.

Якщо вы працуеце ў большай корпаратыўнай средзе, на гэты момент знаўства OpenAPI ёсць практычна обавязковымі.

3. Node.js: Адміністрацыйная частка роботы з інтэграцыяй

Node.js стаў аднай з праблематычных платформ для інжынераў, якія займаюцца інтэграцыяй.

Яго дизайн, адаснованы на змаганнях падзеяў, чыніць яго адпаведным для:

• REST API
• Webhooks
• Мікросервісы
• Системы рэальнага часу
• API-шлюзы
• З’яўлення з сервісамі трэціх сторон

Тыповая наладка можа выглядаць так:

Frontend
   |
Node.js API Gateway
   |
   +-- Payment Services
   +-- CRM Systems
   +-- ERP Platforms
   +-- Notification Services

Стварэнне простаг API трэбуе вельмі мало коду:

const express = require("express");

const app = express();

app.get("/health", (req, res) => {
  res.json({
    status: "OK"
  });
});

app.listen(3000);

Node.js таксама эфектыўны пад час выканання запытоў да зовнішніх сервісаў:

const axios = require("axios");

const users = await axios.get(
    "https://api.example.com/users"
  );

І ён таксама лёгка обробляе прыходзячыя падзеі Webhooks:

app.post("/webhook", (req, res) => {
  console.log(req.body);
  res.sendStatus(200);
});

Для тых, хто займаецца інтэграцыяй, Node.js часта становіцься з’ёднальным шаром, які спаюе разнае бізнес-системы.

4. Axios і Fetch: Комунікацыя з іншымі сервісамі

Значны частка дня інжынера з інтэграцыі прыходзіцца на адправку HTTP-запыткаў.

У гэтым аблаке домінуюць два інструменты: Axios і Fetch.

Axios

Axios вялікі час ёсць фактычным стандартам у гэй кантэксте.

Його інсталяцыя ўсё проста:

npm install axios

Адправка запыткі выглядае так:

const response =
  await axios.get(
    "https://api.example.com/users"
  );

console.log(response.data);

Даўжэнне заголовка аутанізацыі выглядае так:

await axios.get(url, {
  headers: {
    Authorization:
      `Bearer ${token}`,
    "x-api-key":
      process.env.API_KEY
  }
});

Серед прычын, чаму Axios ўпадае ў нягодзе, можна вывесіць:

• Аўтаматычная парсація адпаведзей у формате JSON
• Вбудованая падтрымка тайма-аўта
• Інтэрцепторы для запыткаў
• Болей простая обработка адзінакоў
• Гэты тип гнучкасці, якой часта патрабуюць корпаратыўныя сістэмы

Fetch

У новейшых версіях Node.js Fetch ўжо є вбудованым.

Няма нічога дадатковага, што трэба інсталаваць.

Просты прыклад:

const response = await fetch(
    "https://api.example.com/users"
  );

const users = await response.json();

Адрасаванне запита POST не ўскладненяе роботу значна:

await fetch(
  "https://api.example.com/users",
  {
    method: "POST",
    headers: {
      "Content-Type":
        "application/json"
    },
    body: JSON.stringify({
      name: "John"
    })
  }
);

Fetch є простым і вбудованым засобам, тады як Axios застаецца популярным у большых корпоратыўных проектах.

Axios протык Fetch

Оба інструмента заслуговуюць на месца ў вашай навыковой суткасі, але якщо мета — працаваць над інтэграцыямі ў корпоратыўных проектах, краща спачатку сфокусавацца на Axios.

Рэкамендуемы парадок навучэння

Якщо мета — стаць інжынерам з інтэграцый у Node.js, такі парадок ўсё прыемны:

1. Пачніце з Postman, каб адчуўце сябе ў тэставанні API.
2. Развіце моцныя навыкі ў базах REST і HTTP.
3. Станьце майстрамі Axios для вызову звучных API.
4. Створыце сервісы на базе Express і Node.js.
5. Пазнайомьцеся з Swagger і OpenAPI для стварэння дакументацыі.
6. Выучыце, як працююць механізмы аутэнтыкацыі JWT і OAuth 2.0.
7. Практыкуйце стварэнне webhooks і процесаў, керованых падзеямі.

Выклікайце тэхнікі стойкасці, такія як логіка павторных спроб і карэстаўванне часу.

Гэтыя практыкі адбіваюць, як фаховыя каманды з інтэграціі на самай працоўной адстройваюць свой процес навчання і работы.

Заключныя меркі

Найлепшыя інжынеры з інтэграціі — это не тыя, хто запам’ятавае больш заўсёды працэсароў.

Тое, што яны адзінакавае, — гэта ўмеласць з’едынаць разныя системы.

Postman дапамагае пераканацца ў правільнасці API.

Swagger дапамагае документаваць ія і разумець іх функцыі.

Node.js даёт можлівасць ствараць самыя сервісы інтэграціі.

Axios і Fetch дазваляюць весты канект з іншымі системамі.

Якщо вы мацернаеўце гэтыя чатыры інструменты, у вас будзе надзейны фундамент для стварання інтэграцый, на якія кожны дзень пасляўляюцься компаніі.

Спаднёе чытанне

• Контроль канарыцтва ў Node.js: Как аэватаць збоі API за дапамой p-map і Bottleneck — Дазвольце вам дазнацца, як саюз p-map і Bottleneck у Node.js запобегае памылкам, выкалічаным лімітамах частоты і перавантажэнню системы, шчырз кантроль канарыцтва і часу адпаведзення на запиты.
• Канэкцыя API у Node.js: Каркас оптымізацыі за прыоритэтамі — Дазвольце вам дазнацца, як класіфікуваць способы падбору канэкцыі API у Node.js за ступенем зусиль і ўплыву, каб спачатку выправіць проблемы з пуламы канэксій і запытамі типу N+1, а ўжо пасля працаваць над экзотычнымі спосабамі оптымізацыі.