メインコンテンツまでスキップ

APIの作成​

NocodilySuite では、3種類のAPIを作成できます。
用途に応じて適切なAPIを選択し、コンソール上で定義するだけで自動的にAPIが構築されます。

APIの種類用途
IAM API（認証基盤API）ユーザー認証・組織管理・RBAC・SSO の基盤
MicroService API業務ロジック・データ管理のためのREST API
Storage APIファイル・画像・動画のアップロード/ダウンロード

IAM API（認証基盤API）の作成​

  1. コンソールでチームを選択します。
  2. 「API」>「新規API作成」 をクリックします。
  3. 「IAM API」 を選択します。
  4. 以下の項目を設定します。
項目説明
API名識別用の名称（例: production-auth）
環境TestEnv / DevelopEnv / StagingEnv / ProductionEnv
データベースエンジンIn-Memory（テスト用）または Postgres（永続化）
初期管理者メールアドレス最初の AdminUser のメールアドレス
初期管理者パスワード最初の AdminUser のパスワード
  1. 「作成」 をクリックします。

作成後、OpenAPI仕様がコンソール上で確認できます。
詳細な仕様は 認証基盤API (IAM API) を参照してください。

MicroService API の作成​

  1. コンソールでチームを選択します。
  2. 「API」>「新規API作成」 をクリックします。
  3. 「MicroService API」 を選択します。
  4. 以下の項目を設定します。
項目説明
API名識別用の名称（例: inventory-api）
環境TestEnv / DevelopEnv / StagingEnv / ProductionEnv
データベースエンジンIn-Memory（テスト用）または Postgres（永続化）
認証連携（任意）接続する IAM API を選択（認証・RBAC を有効化）

  1. データ構造（スキーマ）を定義します。

    • エンドポイント名・フィールド名・フィールドの型を設定
    • 認証が必要なエンドポイントかどうかを設定

  2. 「作成」 をクリックします。

作成後、CRUD操作のエンドポイントが自動生成されます。
詳細な仕様は マイクロサービスAPI (MicroService API) を参照してください。

Storage API の作成​

  1. コンソールでチームを選択します。
  2. 「API」>「新規API作成」 をクリックします。
  3. 「Storage API」 を選択します。
  4. 以下の項目を設定します。
項目説明
API名識別用の名称（例: file-storage）
環境TestEnv / DevelopEnv / StagingEnv / ProductionEnv
ストレージエンジンLocal Storage（テスト用）または Object Storage（永続化）
認証連携（任意）接続する IAM API を選択（認証・アクセス制御を有効化）
  1. 「作成」 をクリックします。

作成後、アップロード・ダウンロード用のエンドポイントが自動生成されます。
詳細な仕様は ストレージAPI (Storage API) を参照してください。

APIの作成後​

作成したAPIはコンソール上で以下を確認・管理できます。

  • OpenAPI仕様の確認: 自動生成されたインターフェース仕様を閲覧
  • テスト実行: コンソール上からAPIリクエストを送信してレスポンスを確認
  • バージョン管理: アップグレード・ロールバック で安全に更新
  • ログ確認: アクセスログ・エラーログをコンソールから参照