API管理
使用AI代理構建
API 管理後端

API 管理應用後端模板
內部端點目錄和 API 金鑰監控

在 Back4app 上的生產就緒API 管理後端,具有端點目錄和 API 金鑰監控。包括 ER 圖、數據字典、JSON 架構、API 操作台,以及快速啟動的AI 代理提示。

關鍵要點

此模板為您提供一個具有端點目錄和 API 金鑰監控的 API 管理後端,讓您的團隊可以專注於 API 的使用和安全性。

  1. 以端點為中心的架構設計使用詳細的元數據和監控功能來建模 API 端點。
  2. API 金鑰管理利用 Back4app 的功能來生成和監控 API 金鑰。
  3. 使用追蹤追蹤 API 使用情況和性能指標,以便更好地管理資源。
  4. 安全性和訪問控制實施強大的安全措施以保護 API 訪問和使用。
  5. 跨平台 API 管理通過單一的 REST 和 GraphQL API 為移動和網絡客戶端提供端點和 API 密鑰。

什麼是 API 管理應用後端模板?

Back4app 是一種後端即服務 (BaaS),用於快速產品交付。API 管理應用後端模板是一個預構建的架構,包含 API 端點、密鑰和使用日誌。連接您喜愛的前端(React、Flutter、Next.js 等),更快交付。

最佳適用於:

API 管理應用內部端點編目API 密鑰監控和安全以移動優先的 API 管理應用程式MVP 發佈選擇 BaaS 作為 API 產品的團隊

概覽

一個 API 管理產品需要端點編目、API 密鑰管理和使用監控。

此模板定義了具有監控功能和所有權規則的 API 端點、API 密鑰和使用日誌,以便團隊能夠快速實施 API 管理。

核心 API 管理功能

此中心的每個技術卡片都使用相同的 API 管理後端架構,包括 API 端點、API 密鑰和使用記錄。

API 端點目錄

API 端點類別存儲名稱、路徑、方法和描述。

API 金鑰生成和管理

API 金鑰類別連結金鑰、狀態和使用情況。

使用記錄和監控

使用記錄類儲存端點參考、密鑰、時間戳和響應時間。

安全和訪問控制

實施強大的安全措施以確保 API 訪問和使用的安全。

為什麼要使用 Back4app 構建您的 API 管理後端?

Back4app 提供端點、API 金鑰和使用監控基礎功能,讓您的團隊可以專注於 API 性能和安全性,而不是基礎設施。

  • 端點和金鑰管理: 具有元數據字段的 API 端點類和用於訪問管理的 API 金鑰類支持 API 使用。
  • 使用和性能跟踪: 跟踪 API 使用和性能指標以優化資源分配。
  • 實時 + API 靈活性: 使用 Live Queries 監控更新,同時保持 REST 和 GraphQL 可供每個客戶端使用。

在所有平台上使用一個後端合約快速構建和迭代 API 管理功能。

核心優勢

一個 API 管理後端,幫助您快速迭代而不犧牲結構。

快速 API 管理啟動

從完整的端點和密鑰架構開始,而不是從零設計後端。

實時監控支持

利用實時使用監控和警報來增強 API 性能。

清晰的訪問控制流程

使用 ACL 和 CLP 管理 API 訪問,確保操作安全和數據完整性。

可擴展的權限模型

使用 ACL/CLP 以便只有授權用戶可以管理端點和密鑰,並監控使用情況。

使用和性能數據

存儲和聚合使用日誌以供顯示和分析,無需重置架構。

AI 引導流程

使用一個結構化的提示快速生成後端框架和整合指導。

準備好推出您的 API 管理應用程式了嗎?

讓 Back4app AI Agent 為您的 API 管理後端搭建框架,並從一個提示中生成端點、密鑰和使用日誌。

免費開始 — 每月 50 次 AI Agent 提示,不需要信用卡

技術堆疊

此 API 管理後端模板中包含的一切。

前端
13+ 技術
後端
Back4app
資料庫
MongoDB
身份驗證
內建身份驗證 + 會話
API
REST 和 GraphQL
實時
Live Queries

ER 圖

API 管理後端架構的實體關係模型。

查看圖表來源
Mermaid
erDiagram
    User ||--o{ API : "owner"
    API ||--o{ Endpoint : "api"
    API ||--o{ APIKey : "api"
    APIKey ||--o{ UsageLog : "apiKey"
    Endpoint ||--o{ UsageLog : "endpoint"

    User {
        String objectId PK
        String username
        String email
        String password
        Date createdAt
        Date updatedAt
    }

    API {
        String objectId PK
        String name
        String description
        Pointer owner FK
        Date createdAt
        Date updatedAt
    }

    Endpoint {
        String objectId PK
        Pointer api FK
        String path
        String method
        String description
        Date createdAt
        Date updatedAt
    }

    APIKey {
        String objectId PK
        String key
        Pointer owner FK
        Pointer api FK
        Date createdAt
        Date updatedAt
    }

    UsageLog {
        String objectId PK
        Pointer apiKey FK
        Pointer endpoint FK
        Date timestamp
        Number status
        Number responseTime
        Date createdAt
        Date updatedAt
    }

整合流程

身份驗證、API 端點、密鑰和使用監控的典型運行時流程。

查看圖表來源
Mermaid
sequenceDiagram
  participant User
  participant App as API Management App
  participant Back4app as Back4app Cloud

  User->>App: Login
  App->>Back4app: POST /login
  Back4app-->>App: Session token

  User->>App: Create API
  App->>Back4app: POST /classes/API
  Back4app-->>App: API objectId

  User->>App: Add Endpoint
  App->>Back4app: POST /classes/Endpoint
  Back4app-->>App: Endpoint objectId

  User->>App: Generate API Key
  App->>Back4app: POST /classes/APIKey
  Back4app-->>App: APIKey objectId

  User->>App: Monitor Usage
  App->>Back4app: GET /classes/UsageLog
  Back4app-->>App: Usage logs

數據字典

API 管理架構中每個類的完整字段級別參考。

字段類型描述必需
objectIdStringAuto-generated unique identifier自動
usernameStringUser login name
emailStringUser email address
passwordStringHashed password (write-only)
createdAtDateAuto-generated creation timestamp自動
updatedAtDateAuto-generated last-update timestamp自動

User 中的 6 欄位

安全性和權限

ACL 和 CLP 策略如何保護 API 端點、密鑰和使用日誌。

端點訪問控制

只有授權用戶可以更新或刪除端點;其他人無法修改 API 內容。

密鑰和使用完整性

只有管理員可以創建或刪除 API 密鑰。使用 Cloud Code 進行驗證。

範圍讀取權限

限制使用日誌的讀取權限給相關方(例如,管理員可以查看所有日誌,用戶只能查看自己的使用情況)。

結構(JSON)

原始 JSON 結構定義,準備複製到 Back4app 或用作實施參考。

JSON
{
  "classes": [
    {
      "className": "User",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "username": {
          "type": "String",
          "required": true
        },
        "email": {
          "type": "String",
          "required": true
        },
        "password": {
          "type": "String",
          "required": true
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "API",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "name": {
          "type": "String",
          "required": true
        },
        "description": {
          "type": "String",
          "required": false
        },
        "owner": {
          "type": "Pointer",
          "required": true,
          "targetClass": "User"
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "Endpoint",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "api": {
          "type": "Pointer",
          "required": true,
          "targetClass": "API"
        },
        "path": {
          "type": "String",
          "required": true
        },
        "method": {
          "type": "String",
          "required": true
        },
        "description": {
          "type": "String",
          "required": false
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "APIKey",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "key": {
          "type": "String",
          "required": true
        },
        "owner": {
          "type": "Pointer",
          "required": true,
          "targetClass": "User"
        },
        "api": {
          "type": "Pointer",
          "required": true,
          "targetClass": "API"
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    },
    {
      "className": "UsageLog",
      "fields": {
        "objectId": {
          "type": "String",
          "required": false
        },
        "apiKey": {
          "type": "Pointer",
          "required": true,
          "targetClass": "APIKey"
        },
        "endpoint": {
          "type": "Pointer",
          "required": true,
          "targetClass": "Endpoint"
        },
        "timestamp": {
          "type": "Date",
          "required": true
        },
        "status": {
          "type": "Number",
          "required": true
        },
        "responseTime": {
          "type": "Number",
          "required": false
        },
        "createdAt": {
          "type": "Date",
          "required": false
        },
        "updatedAt": {
          "type": "Date",
          "required": false
        }
      }
    }
  ]
}

使用 AI 代理構建

使用 Back4app AI 代理從此模板生成一個真實的 API 管理應用,包括前端、後端、身份驗證和 API 端點、密鑰和使用流程。

Back4app AI 代理
準備構建
在Back4app上創建一個API管理應用後端,具有此精確的架構和行為。

架構:
1. API端點:名稱(字符串,必填),路徑(字符串,必填),方法(字符串,必填),描述(字符串);objectId,createdAt,updatedAt(系統)。
2. API密鑰:密鑰(字符串,必填),狀態(字符串:活躍,非活躍,必填),使用量(數字);objectId,createdAt,updatedAt(系統)。
3. 使用日誌:端點(指向API端點的指針,必填),密鑰(指向API密鑰的指針,必填),時間戳(日期,必填),響應時間(數字);objectId,createdAt,updatedAt(系統)。

安全性:
- 只有授權用戶可以更新/刪除端點。只有管理員可以創建/刪除API密鑰。使用雲代碼進行驗證。

身份驗證:
- 註冊,登錄,登出。

行為:
- 列出端點,生成密鑰,記錄使用情況,監控性能。

交付:
- Back4app應用,包含架構,ACLs,CLPs;API端點、密鑰和使用監控的前端。

按下下面的按鈕以打開代理,並預填寫此模板提示。

這是沒有技術後綴的基本提示。您可以在之後調整生成的前端堆棧。

幾分鐘內部署每月50個免費提示不需要信用卡

API遊樂場

在API管理架構中嘗試REST和GraphQL端點。響應使用模擬數據,不需要Back4app帳戶。

正在加載遊樂場…

使用與此模板相同的架構。

選擇您的技術

展開每張卡片以查看整合步驟、狀態模式、數據模型範例和離線注意事項。

Flutter API 管理後端

React API 管理後端

React 原生 API 管理後端

Next.js API 管理後端

JavaScript API 管理後端

Android API 管理後端

iOS API 管理後端

Vue API 管理後端

Angular API 管理後端

GraphQL API 管理後端

REST API API 管理後端

PHP API 管理後端

.NET API 管理後端

每種技術的獲得內容

每個技術堆疊使用相同的 API 管理後端架構和 API 合約。

統一的 API 管理 數據結構

輕鬆管理 API 端點,擁有一致的數據結構。

安全的 API 密鑰管理

輕鬆生成和管理 API 密鑰以實現安全訪問。

全面的使用日誌

跟踪和分析 API 使用情況,並具備詳細的日誌功能。

REST/GraphQL 支持 API 管理

在 REST 或 GraphQL 之間選擇,以靈活檢索數據。

可擴展的架構,用於 API 管理

輕鬆添加新功能或修改現有功能以滿足您的需求。

無縫的前端集成

連接您喜愛的前端框架以快速部署。

API 管理框架比較

比較所有支持的技術的設置速度、SDK 風格和 AI 支持。

框架設置時間API 管理的好處SDK 類型AI 支援
約 5 分鐘在移動端和網頁上使用單一的代碼庫進行 API 管理。Typed SDK完整
不到 5 分鐘針對 API 管理的快速網頁儀表板。Typed SDK完整
~3–7 分鐘跨平台的移動應用程序用於 API 管理。Typed SDK完整
快速(5 分鐘)設置用於 API 管理的服務器渲染網頁應用程序。Typed SDK完整
~3–5 分鐘用於 API 管理的輕量級網頁集成。Typed SDK完整
約 5 分鐘用於 API 管理的原生 Android 應用程序。Typed SDK完整
不到 5 分鐘用於 API 管理的原生 iOS 應用程序。Typed SDK完整
~3–7 分鐘React 的網頁用戶介面,用於 API 管理。Typed SDK完整
快速(5 分鐘)設置用於 API 管理的企業網頁應用程序。Typed SDK完整
不到 2 分鐘用於 API 管理的靈活 GraphQL API。GraphQL API完整
快速(2 分鐘)設置REST API 集成用於 API 管理。REST API完整
~3 分鐘用於 API 管理的服務器端 PHP 後端。REST API完整
~3–7 分鐘.NET 後端用於 API 管理。Typed SDK完整

設置時間反映了從項目啟動到使用此模板架構進行首次 API 查詢的預期持續時間。

常見問題

關於使用此模板構建API管理後端的常見問題。

什麼是 API 管理後端?
API 管理模板包含什麼?
為什麼使用 Back4app 作為 API 管理應用程式?
如何使用 Flutter 查詢端點和金鑰?
如何使用 Next.js Server Actions 創建使用日誌?
React原生應用可以離線緩存端點和鍵嗎?
如何防止API鍵重複?
在Android上顯示API端點和鍵的最佳方式是什麼?
使用監控流程是如何從頭到尾運作的?

受到全球開發者的信賴

加入使用 Back4app 模板更快交付 API 管理產品的團隊

G2 Users Love Us Badge

準備好構建您的 API 管理應用程序了嗎?

在幾分鐘內開始您的 API 管理項目。無需信用卡。

選擇技術