開発者向け文書

アドオン開発

アドオン作成ルール、公開可能範囲、依存制約を説明します。

開発13
ローカル開発環境の実キャプチャ
開発者向け文書では、公開API、外部通知、認証、権限の確認点を画面上の導線と一緒に示します。
ローカル開発環境で撮影した開発者向け技術文書ページ

操作前の確認

実装前にAPI、認証、権限、ログの責務を切り分けます。

標準手順

画面で再現できる状態を作り、APIレスポンスとログを同じ時刻で突き合わせます。

証跡の残し方

連携失敗時はレスポンス、アクセスログ、監査ログ、外部通知の配送履歴をそろえて調査します。

この文書で扱う機能

画面ガイド

実際のコンソール導線に合わせて、対象機能、操作ステップ、確認ポイントを画面例で追えるようにしています。

/docs/developers
ナビゲーション
設定/権限
公開API
管理基盤
設定/権限
1
標準構造
2
依存制約
3
公開文書

確認ポイント

1. 標準構造
2. 依存制約
3. 公開文書
関連文書を検索
アドオン開発の責務分割

機能単位のアドオンを作り、共通処理はpackagesへ逃がして依存を整理します。

標準構造

backend、frontend、schema、shared、types を基本単位にし、apps からアドオンを組み込みます。

1. 標準構造 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

1. 標準構造 の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。

依存制約

addons から apps を参照せず、共有処理は packages に切り出します。

2. 依存制約 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

2. 依存制約 の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。

公開文書

外部公開できる概念と、内部運用に閉じる情報を分けて管理します。

3. 公開文書 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

3. 公開文書 の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。