跳到主要內容

Blocklet 規範 (blocklet.yml)

blocklet.yml 檔案是每個 Blocklet 的核心。它是一個 YAML 清單,定義了您應用程式的所有基本元數據,作為 Blocklet Server 和生態系統中其他工具的唯一真實來源。

您可以將其視為 Node.js 世界中 package.json 的對應物,但其範圍擴展到涵蓋去中心化應用程式的完整生命週期和配置。它詳細說明了從 Blocklet 的身份和版本到其運行方式、公開的 Web 介面、對其他 Blocklet 的依賴以及如何與使用者介面整合的所有內容。

本規範是 blocklet.yml 中每個可用欄位的權威參考。無論您是建置一個簡單的靜態網站還是一個複雜的多服務應用程式,一個格式良好的 blocklet.yml 都是確保其正確、可預測運行的第一步。

基本範例

以下是一個最小的 blocklet.yml 檔案,以說明其基本結構。每個欄位在下面的章節中都有詳細解釋。

blocklet.yml

yaml
# Blocklet 的核心身份
did: z8iZpA63mBCy9j82Vf9aL3a8u9b5c7d9e1f2
name: my-awesome-blocklet
version: 1.0.0

# 人類可讀的元數據
title: My Awesome Blocklet
description: 一個簡單的 Blocklet,用於展示核心概念。

# Blocklet 的執行方式
main: api/index.js

# Blocklet 如何對外暴露
interfaces:
  - type: web
    name: publicUrl
    path: /
    prefix: '*'
    port: BLOCKLET_PORT
    protocol: http

# 系統需求
requirements:
  server: ">=1.16.0"
  os: "*"
  cpu: "*"

規範章節

blocklet.yml 規範被組織成屬性的邏輯分組。探索以下章節,以獲得每個欄位、其目的和有效值的全面指南。

現在您對 blocklet.yml 的結構有了概覽,請深入研究以上特定章節以找到您需要的詳細資訊。有關此元數據的程式化互動,請參閱 API 參考。