節點幫助

LoopBack node js（它如何為開發人員工作）

發佈 2024年9月29日

介紹

透過 IronPDF（一個程式化創建 PDF 文件的庫）與 LoopBack（一個用於構建 API 的 Node.js 框架）的順暢整合，提供在 LoopBack 框架應用程序中進行動態 PDF 生成的完整解決方案。憑藉模型創建、數據源驗證、遠程方法和訪問控制等功能，LoopBack 框架使 API/網頁開發更簡單，而 IronPDF 通過更先進的 PDF 生成功能加以提升。

開發人員可以透過這個整合，即時從多個來源（包括外部 API 和資料庫）提取資料來建立 PDF。這使得能夠創建自訂記錄或業務領域對象以滿足專案需求，如發票、證書、報告等。由於 LoopBack 是異步的，它補充了 IronPDF 的功能以處理PDF在不干擾事件迴圈的情況下生成任務，確保回應性和最佳性能。

要開始使用 LoopBack 和 IronPDF，請利用 LoopBack 的 CLI 工具創建一個新項目，並使用 npm 安裝 IronPDF 作為依賴項。利用 LoopBack 的中介軟體和遠端方法功能，能夠立即根據客戶請求創建 PDF，從而簡化整合。總而言之，這項整合使開發者能夠在 LoopBack 應用中有效地處理各種文件生成需求。

什麼是 LoopBack Node.js？

一個強大的 Node.js 框架稱為LoopBack被創建用於簡化創建 API 及將它們連接到不同數據來源的過程。使用 LoopBack（一款由 StrongLoop 開發的產品），開發人員可以輕鬆設計可伸縮且適應性強的應用程式。從根本上來說，LoopBack 是建立在 express 框架之上的，並且基於模型驅動開發的方法論，這讓程序員能夠創建代表其應用程式領域的數據模型。關聯式資料庫如 MySQL 和 PostgreSQL，NoSQL 資料庫如 MongoDB，以及外部的 REST API 和 SOAP 服務，都可以輕鬆地與這些模型整合。

LoopBack 的獨特之處在於它通過根據提供的模型自動生成 RESTful 端點，簡化了 API 開發過程。此外，LoopBack 提供整合的驗證、權限和身份驗證支援，使程式設計師能夠保護其 API 並保證資料完整性。由於 LoopBack 的中介軟體架構基於 Express.js，具備可擴充性和靈活性，使開發人員能夠使用現有的中介軟體或創建量身定制的中介軟體以滿足獨特的需求。

無論您是在創建簡單的 REST API 還是複雜的微服務架構，LoopBack 都具備所需的功能和工具，可以加速開發並產生可靠且可擴展的解決方案。由於其全面的文檔和活躍的社群，開發人員在創建尖端的網路和行動應用程式時常常選擇它。

LoopBack node.js（開發者如何使用）：圖 1 - LoopBack

LoopBack的功能

模型驅動架構：透過允許開發者使用基於架構的方法來定義數據模型，LoopBack 支持模型驅動的開發。各種資料來源，包括資料庫、REST API 和 SOAP 服務，可以使用模型來表示。

資料來源不可知論：關聯式資料庫(MySQL, PostgreSQL), NoSQL 資料庫(MongoDB)外部 REST API 和 SOAP 服務只是 LoopBack 支援的眾多數據來源之一。

自動化 REST API 生成：LoopBack 使用預定義的模型在 API Explorer 中自動創建 RESTful API 端點，減少樣板代碼並加速開發。

內建的身份驗證和授權支持：LoopBack 提供內建的這些功能支持，使開發人員能夠納入基於角色的訪問控制(RBAC)、使用者身份驗證以及其他安全措施整合到他們的API中。

中介軟體與遠端方法：開發人員可以使用LoopBack來提供中介軟體和遠端方法，以改變API端點的行為。雖然遠端方法提供可透過 HTTP 遠端調用的自訂功能，但中介軟體功能可以攔截和修改請求及回應。

命令行界面(命令行界面 (CLI))適用於 LoopBack：LoopBack 包括一個強大的 CLI 工具，使建立模型和控制器、構建新專案和執行遷移等典型活動變得更加容易。

與 LoopBack 元件整合：LoopBack 促進元件的使用，這些元件是可重複使用的模組，提供電子郵件傳遞、檔案儲存和身份驗證功能。這樣可以讓開發人員在為應用程式添加新功能時不必從頭開始。

LoopBack Explorer：開發者可以使用 LoopBack 的整合式 API 探索工具，互動地檢查和測試 API 端點。這有助於故障排除並了解 API 的可能性。

創建和配置LoopBack Node.js JS

您可以使用以下步驟在 Node.js 中設置和構建 LoopBack 應用程序：

安裝 LoopBack CLI

安裝 LoopBack 命令行介面(命令行界面 (CLI))，提供用於構建和管理 LoopBack 應用的資源，是第一步。使用 npm 全局安裝它：

npm install -g loopback-cli

創建新的 LoopBack 應用程式

若要構建一個全新的核心 LoopBack 應用程式，請使用 CLI。在您希望構建應用程序的目錄中打開並在那裡執行：

lb4 app

lb4 app

JAVASCRIPT

要提供有關您的應用程式的信息，例如其名稱和目錄以及您希望啟用的功能，只需按照提示進行操作。

系統將提示您提供以下信息：

專案名稱：輸入您的應用程式名稱，例如，my-loopback-app。
專案描述：可選擇描述您的應用程式。
專案根目錄：接受預設值或指定其他目錄。
Application 類別名稱：接受預設的 Application。
啟用 Prettier：選擇是否啟用 Prettier 進行程式碼格式化。
啟用TSLINT：選擇是否啟用TSLint進行程式碼檢查。
啟用 Mocha：選擇是否啟用 Mocha 來執行測試。
CLI 將生成專案結構並安裝必要的相依套件。

探索專案結構

您的專案目錄將具有以下結構：

my-loopback-app/
├── src/
│   ├── controllers/
│   ├── models/
│   ├── repositories/
│   ├── index.ts
│   ├── application.ts
│   └── ...
├── package.json
├── tsconfig.json
└── ...

my-loopback-app/
├── src/
│   ├── controllers/
│   ├── models/
│   ├── repositories/
│   ├── index.ts
│   ├── application.ts
│   └── ...
├── package.json
├── tsconfig.json
└── ...

JAVASCRIPT

定義模型

要指定資料的結構，可以手動開發模型或使用 LoopBack CLI。模型可以由各種資料結構和來源支援，以代表程式中的事物。例如，運行：以生成一個名為 Product 的新模型。

lb4 model

lb4 model

JAVASCRIPT

要指定模型的屬性和連接，請遵循指示。

創建控制器

要處理創建 PDF 文件的請求，請創建一個新的控制器。要建立新的控制器，請在 LoopBack CLI 中使用以下命令：

lb4 controller

lb4 controller

JAVASCRIPT

要定義控制器的名稱和相關模型，只需按照提示進行。假設我們想將控制器的屬性名稱與 Report 模型關聯，並稱之為 ReportController。

定義資料來源

確定您的模型將與哪些資料來源進行通信。許多資料庫，例如 MySQL、PostgreSQL、MongoDB 等，都受到 LoopBack 的支持。要配置您的資料來源，您可以更新datasources.json檔案或使用LoopBack CLI。

探索 LoopBack

使用內建的 API 探索工具，可在 http://localhost:3000/explorer 使用，來調查 LoopBack 的功能。您可以在此處探索和測試您的 API 端點。

示範 Ping 控制器程式碼

import {inject} from '@loopback/core';
import {
  Request,
  RestBindings,
  get,
  response,
  ResponseObject,
} from '@loopback/rest';
/**      * OpenAPI response for ping()
 */
const PING_RESPONSE: ResponseObject = {
  description: 'Ping Response',
  content: {
    'application/json': {
      schema: {
        type: 'object',
        title: 'PingResponse',
        properties: {
          greeting: {type: 'string'},
          date: {type: 'string'},
          url: {type: 'string'},
          headers: {
            type: 'object',
            properties: {
              'Content-Type': {type: 'string'},
            },
            additionalProperties: true,
          },
        },
      },
    },
  },
};
/**      * A simple controller to bounce back http requests
 */
export class PingController {
  constructor(@inject(RestBindings.Http.REQUEST) private req: Request) {}
  // Map to `GET /ping`
  @get('/ping')
  @response(200, PING_RESPONSE)
  ping(): object {
    // Reply with a greeting, the current time, the url, and request headers
    return {
      greeting: 'Hello from LoopBack',
      date: new Date(),
      url: this.req.url,
      headers: Object.assign({}, this.req.headers),
    };
  }
}

import {inject} from '@loopback/core';
import {
  Request,
  RestBindings,
  get,
  response,
  ResponseObject,
} from '@loopback/rest';
/**      * OpenAPI response for ping()
 */
const PING_RESPONSE: ResponseObject = {
  description: 'Ping Response',
  content: {
    'application/json': {
      schema: {
        type: 'object',
        title: 'PingResponse',
        properties: {
          greeting: {type: 'string'},
          date: {type: 'string'},
          url: {type: 'string'},
          headers: {
            type: 'object',
            properties: {
              'Content-Type': {type: 'string'},
            },
            additionalProperties: true,
          },
        },
      },
    },
  },
};
/**      * A simple controller to bounce back http requests
 */
export class PingController {
  constructor(@inject(RestBindings.Http.REQUEST) private req: Request) {}
  // Map to `GET /ping`
  @get('/ping')
  @response(200, PING_RESPONSE)
  ping(): object {
    // Reply with a greeting, the current time, the url, and request headers
    return {
      greeting: 'Hello from LoopBack',
      date: new Date(),
      url: this.req.url,
      headers: Object.assign({}, this.req.headers),
    };
  }
}

JAVASCRIPT

來自上述代碼的輸出。

LoopBack node js（對開發者的運作方式）：圖 2 - LoopBack 輸出

入門

我們將開始創建一個範例應用程式，使用 LoopBack Node.js 和 IronPDF 來建立具有動態生成資訊的 PDF 文件。這是一本帶有詳細說明的分步手冊。

什麼是 IronPDF？

名為IronPDF開發此產品是為了讓創建、編輯和維護PDF變得更容易。使用此應用程式，開發人員可以從 HTML 文件中提取文本和圖像，應用頁首和浮水印，合併多個 PDF 文件，並執行各種其他操作。由於 IronPDF 的用戶友好 API 和全面的文檔，開發人員可以輕鬆自動創建高質量的 PDF 文件。 IronPDF 提供了所有功能和能力，以改善文檔工作流程，並在各種情境中提供一流的用戶體驗，無論是用於準備發票、報告或文檔。

LoopBack node js（開發人員如何使用）：圖 3 - IronPDF

IronPDF 的功能

HTML 到 PDF 的轉換 是一個簡單快速的過程，適用於任何 HTML 內容，包括 CSS 和 JavaScript。

PDF 文件合併：為了簡化文件管理任務，將多個 PDF 文件合併成單個 PDF 文件。

文字與圖片提取：從 PDF 檔案中提取文字和圖片，以便進行額外的數據分析或處理。

水印：出於安全或品牌宣傳的原因，您可以在 PDF 頁面上添加文字或圖片水印。

包含頁首和頁尾：PDF文件的頁首和頁尾允許您包含自訂訊息或頁碼。

安裝 IronPDF

要啟用 IronPDF 功能，請使用 Node 套件管理器安裝必要的 Node.js 套件。

npm install @ironsoftware/ironpdf

將 Loopback 與 IronPDF Node.js 整合

在創建的控制器文件中實現以下邏輯(report.controller.ts 或 report.controller.js js 檔案)使用 IronPDF 創建 PDF 文件：

import {inject} from '@loopback/core';
import {
  Request,
  RestBindings,
  get,
  response,
  ResponseObject,
  oas,
  param,
  Response,
  requestBody,
} from '@loopback/rest';
const IronPdf = require("@ironsoftware/ironpdf");
const document=IronPdf.PdfDocument;
var config=IronPdf.IronPdfGlobalConfig
config.setConfig({licenseKey:''});
/
 * A simple controller to bounce back http requests
 */
export class ReportController {
      @get('/generate-pdf', {
        responses: {
          '200': {
            description: 'PDF file',
            content: {'application/pdf': {schema: {type: 'string', format: 'binary'}}},
          },
        },
      })
      async generatePdf(): Promise<Buffer> {
        // Example HTML content
        const htmlContent = '<html><body><h1>Hello, IronPDF!</h1></body></html>';
        const pdf = (await document.fromHtml(htmlContent));
        const pdfBuffer=await pdf.saveAsBuffer();
        return pdfBuffer;
      }
constructor(@inject(RestBindings.Http.REQUEST) private req: Request) {}
}

import {inject} from '@loopback/core';
import {
  Request,
  RestBindings,
  get,
  response,
  ResponseObject,
  oas,
  param,
  Response,
  requestBody,
} from '@loopback/rest';
const IronPdf = require("@ironsoftware/ironpdf");
const document=IronPdf.PdfDocument;
var config=IronPdf.IronPdfGlobalConfig
config.setConfig({licenseKey:''});
/
 * A simple controller to bounce back http requests
 */
export class ReportController {
      @get('/generate-pdf', {
        responses: {
          '200': {
            description: 'PDF file',
            content: {'application/pdf': {schema: {type: 'string', format: 'binary'}}},
          },
        },
      })
      async generatePdf(): Promise<Buffer> {
        // Example HTML content
        const htmlContent = '<html><body><h1>Hello, IronPDF!</h1></body></html>';
        const pdf = (await document.fromHtml(htmlContent));
        const pdfBuffer=await pdf.saveAsBuffer();
        return pdfBuffer;
      }
constructor(@inject(RestBindings.Http.REQUEST) private req: Request) {}
}

JAVASCRIPT

Report 實例的創建和 PDF 生成由 ReportController 處理。 HTML 內容使用 IronPDF 轉換為 PDF 緩衝區，並通過 generatePdf 方法返回。

要將 HTML 渲染為 PDF，generatePdf 函數使用 IronPDF。 LoopBack 控制器輕鬆處理此整合。然後透過定義一個 get 端點 /generate-pdf 來接收來自客戶端的 HTML 內容。我們利用IronPDF庫在端點內將提供的HTML資訊轉換為PDF。

具體來說，我們使用 pdf.saveAsBuffer。()以生成二進制緩衝區的PDF文件和 IronPdf.fromHtml(html內容)從 JSON 文件構建 PDF 物件。之後，客戶端接收帶有正確 MIME 類型的這個緩衝區。(應用程式/pdf). 在創建 PDF 時出現的任何問題都會被監聽於埠 3000 的伺服器檢測並記錄。客戶端會收到一個 500 狀態碼的回應。此配置使能夠從 HTML 內容創建動態 PDF，這在為網絡應用程式創建賬單、報告或其他文件時非常有用。

LoopBack node js（它如何為開發者工作）：圖 4 - PDF 輸出

結論

最後，IronPDF 與 LoopBack 4 的集成為線上應用程式開發提供了強大的組合。使用 LoopBack 4，開發人員可以輕鬆建立 RESTful API，憑藉強大的框架，使他們能專注於業務邏輯，而非樣板代碼。然而，IronPDF 擁有流暢的 PDF 生成功能，可以從 HTML 文本創建動態 PDF 文件。

此外，開發過程透過 LoopBack 4 和 IronPDF 的靈活性和易用性而簡化，讓開發人員能夠快速製作高質量的應用程式。由於 LoopBack 4 管理 API 後端的存取控制，而 IronPDF 負責 PDF 的創建，開發人員可以專注於滿足業務需求並提供出色的用戶體驗。

通過整合，我們可以保證為客戶和最終用戶提供功能豐富、高端的軟體解決方案。IronPDF和其他八個庫到您的開發堆疊中。此外，這個強大的基礎將使優化後端系統和倡議的過程更加容易。每份起價為 $749，這些技術非常適合當代軟體開發專案，因為它們擁有完整的文件、活躍的線上開發者社群以及頻繁的更新。

< 上一頁
hapi node js（對開發者的運作方式）

下一個 >
xml2js npm（它如何為開發人員運作）