faasjs-specs

FaasJS の仕様

デフォルトのワークフロー

1. ランタイムの動作または公開ドキュメントを変更する前に、関連する仕様を読み込みます。
2. MUST／SHOULD／MAY の表現を規範として扱います。
3. 実装、ドキュメント、テストを仕様に沿った状態に保ちます。
4. 変更が意図的な破壊的変更であり、その旨が文書化されている場合を除き、後方互換性を維持します。

次のリファレンスを読み込む

• faas.yaml の配置、検出、マージ順序、ステージングキー、サーバーノード、プラグインノード、YAML サブセットについては、references/specs/faas-yaml.md を参照してください。
• ゼロマッピングのファイル命名とルート検索順序については、references/specs/routing-mapping.md を参照してください。
• HTTP リクエスト、レスポンスエンベロープ、ステータス、トランスポートの動作については、references/specs/http-protocol.md を参照してください。
• プラグインの識別情報、ライフサイクル実行、設定レイヤー、手動登録、設定駆動の読み込みについては、references/specs/plugin.md を参照してください。

注意点

• 仕様は規範的なものであり、一般的なガイドより厳格な場合があります。
• ルートの動作と設定のマージ順序は、互換性に影響するため慎重に扱ってください。
• HTTP レスポンスの動作では、エンベロープと低レベルのエラーの違いを維持する必要があります。
• プラグイン設定の優先順位は、手動登録と設定駆動の読み込みの両方で一貫させてください。

検証

• 変更した仕様の領域について、対象を絞ったランタイムテストを実行します。
• 仕様のソースを編集した後は、npm run doc を実行します。
• ドキュメントのルーティング、仕様ページ、またはリンクを変更した場合は、cd docs && npm run build を実行します。