GrantForge

    ユーザーガイド

    リソースカタログと API カタログ

    アプリケーションとリソースツリー、リソースの依存関係、OAuth クライアントを管理し、自動登録された API を確認し、カタログのヘルスチェックで壊れた設定を見つけ出します。

    リソースカタログ

    プラットフォーム管理 → リソースカタログ は各アプリケーションのリソースツリーを管理します。コンソール自身(grantforge-console)は組み込みアプリケーションであり、そのページ、ボタン、API は起動時に自動登録され、削除はできません。

    リソースカタログ

    • アプリケーション:業務アプリケーションを新規作成、編集、削除します。クライアントやリソースが存在するアプリケーションは削除できません。
    • リソース:モジュール、メニュー、ページ、タブ、ボタン、API、データエンティティ、フィールドです。タイプによって配置できる場所が決まります。ボタンはページまたはタブの下にのみ、フィールドはデータエンティティの下にのみ配置できます。リソースはドラッグして位置を調整でき、最大 15 階層までです。
    • 状態:リソースを非表示または無効化できます。権限がない場合、ボタンを「非表示」と「無効」のどちらにするかを選択できます。
    • 依存関係:ボタンは自分が呼び出す API を、ページはデータを読み込む API を「必要」とします。権限付与時にはこれらの依存関係も自動的に導出され、詳細ページでは依存関係をグラフで表示します。
    • OAuth クライアント:業務アプリケーション用のクライアントを登録します。OAuth 2.1 と OpenID Connect を参照してください。
    • フィールド:フィールドを選択すると、そのフィールドがどのインターフェースに現れるか(返すか受け取るか)を表示します。

    API カタログ

    プラットフォーム管理 → API カタログ はサーバー起動時に自動登録されたすべてのインターフェースと、それぞれのアクセス要件を列挙します。アクセス要件は、公開、ログインのみで利用可能、特定の権限コードが必要、のいずれかです。権限が必要なインターフェースは権限コードごとにリソースカタログに分類され、ロールに権限を付与する際にこれらの権限を参照します。インターフェースの追加、廃止、または権限コードの変更時には「確認待ちの変更」として一覧表示され、確認するとカタログが更新されます。

    API カタログ

    カタログのヘルスチェック

    プラットフォーム管理 → カタログのヘルスチェック は気づかれないうちに壊れた設定を見つけ出します。対象は、機能していない権限付与、動作できないボタン(必要な API の欠如)、誰も呼び出せない API、切断された依存関係です。ヘルスチェックはデータを読み取るのみで、何も変更しません。

    カタログのヘルスチェック

    GitHub でこのページを編集