Негізгі мазмұнға өту

Узел http in

Узел http in HTTP-сұрауларды (GET, POST, PUT және басқалары) өңдеуге арналған HTTP-эндпоинттерді жасау үшін қолданылады. Бұл узел HTTP протоколы арқылы сыртқы жүйелермен өзара әрекеттесу үшін кіріс нүктесі болып табылады.

Маңызды: Барлық берілген жолдар автоматты түрде префикс алады: /api/admin/workflows/endpoints/.

Настройки узла http in​

IMG2

1. Аты​

Узелдің атын көрсету үшін өріс.
Аты жұмыс аймағында көрсетіледі және узелді оңай анықтауға көмектеседі.
Егер бос қалдырылса, узел http in деп аталады.

Мысал:

  • Узелдің аты: get payment link

2. Әдіс​

Узел өңдейтін HTTP-әдіс. Келесі нұсқалар қол жетімді:

  • GET: Деректерді алу үшін қолданылады.
  • POST: Деректерді жіберу үшін қолданылады.
  • PUT: Деректерді жаңарту үшін қолданылады.
  • DELETE: Деректерді жою үшін қолданылады.
  • PATCH: Деректерді ішінара жаңарту үшін қолданылады.
  • OPTIONS: API туралы метаақпарат алу үшін сұраулар үшін қолданылады.

3. Сілтеме​

Сұрауларды өңдеу үшін жолды (эндпоинт) көрсетеді.

  • Жол / -дан басталады.
  • Маршрут айнымалыларын қамтуы мүмкін, мысалы: /data/:id.

Мысал:

  • Сілтеме: /get-payment-link
  • Параметрі бар сілтеме: /get-payment-link/:orderId

Кіріс хабарламасының форматы​

Сұрау көрсетілген жолға таңдалған әдіспен келгенде, узел http in келесі қасиеттері бар msg хабарламасын жасайды:

  • msg.req: HTTP-сұрау объектісін, оның ішінде заголовкалар, параметрлер, дене және басқа деректерді қамтиды.
    • msg.req.params: Маршрут параметрлері (мысалы, :id /api/data/:id -де).
    • msg.req.query: GET-сұрау параметрлері.
    • msg.req.body: Сұрау денесі (POST, PUT және PATCH әдістері үшін).
  • msg.res: HTTP-жауабын басқару үшін объект. Әдетте клиентке жауап жіберу үшін http response узеліне беріледі.

Мысал қолдану​

Мысал 1: GET-сұрауды өңдеу​

Сценарий: Температура туралы деректерді қайтару.

Узел параметрлері:

  • Әдіс: GET
  • Сілтеме: /temperature

Ағын:

[http in] ---> [function] ---> [http response]

Функция узелінің коды:

msg.payload = { temperature: 22.5, unit: "Celsius" };
return msg;

Нәтиже: /api/admin/workflows/endpoints/temperature -ге GET-сұрау жіберген клиент JSON-жауабын алады:

{
  "temperature": 22.5,
  "unit": "Celsius"
}

Мысал 2: POST-сұрауды өңдеу​

Сценарий: Құрылғыдан деректерді қабылдау және сақтау.

Узел параметрлері:

  • Әдіс: POST
  • Сілтеме: /data

Ағын:

[http in] ---> [function] ---> [http response]

Функция узелінің коды:

// Сұрау денесінен деректерді оқу
const data = msg.req.body;
msg.payload = { status: "success", receivedData: data };
return msg;

Нәтиже: Узел POST-сұрауының денесінен деректерді қабылдайды және растау жауаппен қайтарады.

Мысал 3: Маршрут параметрлерін пайдалану​

Сценарий: Құрылғы идентификаторы бойынша деректерді алу.

Узел параметрлері:

  • Әдіс: GET
  • Сілтеме: /device/:id

Ағын:

[http in] ---> [function] ---> [http response]

Функция узелінің коды:

const deviceId = msg.req.params.id;
msg.payload = { deviceId: deviceId, status: "active" };
return msg;

Нәтиже:

{
  "deviceId": "123",
  "status": "active"
}