Encore 與 Neon 的結合優勢

借助 Encore，開發者可以在整個開發生命周期中充分利用 Neon Postgres，從本地開發到生產環境。這一過程涵蓋了服務與 API、數據庫（如 Neon）、定時任務（Cron Jobs）、發布/訂閱隊列（Pub/Sub & Queues）以及密鑰管理（Secrets）。

在本文中，我們將通過 Encore 模板和 CLI 工具，創建一個 URL 縮短服務。完成本地環境部署后，我們將進一步推送到生產環境。整個服務將基于 Encore 的 TypeScript SDK 構建后端云基礎設施。

準備工作

在開始之前，您需要：

• 安裝 Encore CLI。
• 如果計劃將應用部署到 AWS 或 GCP，需要提前配置相關賬戶并在 Encore 控制臺中完成鏈接。

本文的示例應用將部署到 Encore Cloud。

TypeScript SDK 的優勢

Encore 的 TypeScript SDK 為前端和全棧開發者提供了熟悉的開發語言，支持構建生產級應用和分布式系統。通過 TypeScript，開發者可以輕松從前端開發過渡到后端開發，同時確保類型安全。SDK 允許開發者直接在代碼中聲明基礎設施原語，簡化后端開發流程，加速迭代與調試。

此外，使用 Neon 數據庫時，Encore 還支持配置臨時預覽環境，自動分支數據庫并添加真實數據，從而簡化測試流程。

Encore 的開發工作流程

Encore 提供了一套高效的開發工作流程，包括：

• 本地開發環境：通過簡單的命令即可實例化一個與云環境一致的本地開發環境。
• 內置測試支持：提供服務/API 模擬和專用測試基礎設施，簡化測試流程。
• 自動化云配置：無需手動配置，自動完成云端基礎設施的部署。

如果您不直接使用 AWS 或 GCP，也可以選擇將應用直接部署到 Encore 的云基礎設施。

Neon Serverless Postgres 的優勢

Neon 提供了針對云環境優化的無服務器 Postgres 服務，進一步增強了開發體驗：

• 簡化數據庫管理：Neon 抽象了 Postgres 數據庫的管理復雜性，讓開發者可以專注于應用邏輯。

快速入門：構建第一個應用程序

1. 安裝 Encore CLI

首先，安裝 Encore CLI 工具，它將為您提供本地開發環境并簡化應用程序設置。

2. 創建應用程序

運行以下命令創建應用程序：

encore app create

選擇 TypeScript 和 URL 縮短器模板。此時，應用程序已在本地完成設置，同時在 Encore Web 儀表板中創建了一個應用項目。

3. 瀏覽生成的代碼

在代碼編輯器中打開生成的 TypeScript 文件（url.ts），您會發現定義 API 端點的過程非常簡單，遵循標準的 TypeScript 約定。

4. 啟動本地開發環境

Encore 使用 Docker 重現環境，并拉取 Postgres Docker 鏡像進行測試。數據庫遷移文件位于項目目錄的 url/migrations/url/1_create_tables.up.sql 中。

啟動后，您可以通過開發儀表板 URL 檢查本地運行的應用程序。

部署到 Encore 云

1. 推送到開發云

將更改推送到 Encore 的免費開發云。連接到 Encore 的 Git 服務（Git.Encore.dev），觸發部署流程。

2. 激活預覽環境

通過 GitHub 集成，您可以為每個拉取請求（PR）激活預覽環境。Encore 會自動利用 Neon 的分支功能，為每個 PR 創建獨立的數據庫分支。

3. 查看暫存環境

首次部署時，Encore 會為應用配置和管理 Neon 數據庫。您可以在應用的“暫存”環境中查看基礎設施詳情。

創建生產環境并集成 Neon

1. 配置 Neon API 密鑰

在 Neon 中創建 API 密鑰，并將其添加到 Encore 應用的設置中。

2. 創建生產環境

在 Encore 中創建一個名為“prod”的新環境，并選擇 Neon 作為數據庫提供商。根據需要調整區域和集成設置。

查看已部署的資源

部署完成后，您可以測試應用程序并查看數據庫資源。Neon Postgres 數據庫已在您的賬戶中創建，且遷移已成功應用。Encore 會為生產環境創建一個獨立的 Postgres 分支。

通過 Encore 云儀表板，您可以使用 cURL 測試 API 服務，并驗證數據是否成功寫入 Neon 數據庫。

清理環境

完成測試后，您可以在 Encore 儀表板中刪除不需要的環境，清理應用程序基礎設施。

總結

將 Neon 與 Encore 結合使用，為跨多個環境和云平臺開發可擴展的 API 服務提供了強大的基礎。Encore 簡化了應用程序的開發與部署，而 Neon 則通過無服務器 Postgres 數據庫的管理，讓開發者能夠專注于創新與速度。

目前，Encore 已支持在所有環境中使用 Neon Postgres，包括 AWS 和 GCP 云環境。這一功能使開發者能夠在不同環境和云提供商之間實現無縫的數據庫管理。

原文鏈接: https://neon.tech/blog/building-production-api-services-with-encore-typescript-and-neon-serverless-postgres