API

APIではAPIの作成・設定と、エンドポイントの作成が行なえます。

fetched from Gyazo

メニューリスト

画面上部にメニューリストが表示されます。

fetched from Gyazo

追加

API作成画面が表示されます。

Image from Gyazo

項目説明
タイトルAPIタイトルを記入します(必須)
バージョンを記入します(必須)
説明APIに関する説明を記入します(必須)
追加するクリックすると新しいAPIが作成されます

Swagger UI

Swagger UI画面に遷移します。

Image (fetched from Gyazo)

詳細な利用方法は Swagger UIを利用して、コンテンツのデータ構造を確認するをご確認ください。

キャッシュクリア

API設定のキャッシュをクリアします。
Kuroco内部の動作に変更があった場合、キャッシュをクリアして最新版を適用/反映します。

セキュリティ

APIのセキュリティを設定できます。

Image (fetched from Gyazo)

セキュリティの設定についてはAPI Securityをご覧ください。

CORSを設定する

CORS用に、Kurocoサーバーからレスポンンスヘッダに返却する情報をカスタマイズできます。

Image (fetched from Gyazo)

CORSに設定されたOriginは、Content-Security-Policy: frame-ancestorsに指定されるOriginとしても利用されます。

例えば、ローカル上のフロントエンド http://localhost:8080 からKurocoサーバーにアクセスする場合には、下記のhttp://localhost:8080を設定してください。

詳細はMDNのドキュメントを参照してください。

項目対応するレスポンスヘッダhttp://localhost:8080の例
CORS_ALLOW_ORIGINSAccess-Control-Allow-Originhttp://localhost:8080
CORS_ALLOW_METHODSAccess-Control-Allow-MethodsGET,POST,OPTIONS
CORS_ALLOW_HEADERSAccess-Control-Allow-Headers*
CORS_MAX_AGEAccess-Control-Max-Age600
CORS_ALLOW_CREDENTIALSaccess-control-allow-credentials

APIを更新する

選択中のAPIの設定を変更します。設定項目は新しいAPIを作成すると同じです。

APIを削除する

クリックするとAPIが削除されます。 削除されたAPIの復活はできませんのでご注意ください。

APIエクスポート

JSON/YAML 形式でエクスポートが可能です。

Image (fetched from Gyazo)

エクスポートされるファイルはKuroco独自のフォーマットの設定ファイルです。
エクスポートにpre/post processing設定を含める場合は、「前後の処理ブロックを含む」にチェックを入れてください。

APIインポート

JSON/YAML 形式でインポートが可能です。

Image from Gyazo

「新しいAPIとしてインポート」を選択すると、新しいAPIが作成されます。
「現在のAPIへのインポート」を選択すると、現在のAPIが更新されます。

新しいエンドポイントの追加

エンドポイント作成画面が表示されます。

Image from Gyazo

エンドポイントの作成についてはエンドポイント 設定項目一覧をご覧ください。

エンドポイント一覧

メニューリスト下部にエンドポイントの一覧が表示されます。

Image from Gyazo

新しいAPIを作成した時点では、ここには何も表示されていませんが、エンドポイントを追加することで表が表示されます。
この表は作成したエンドポイントの[カテゴリ]によってグループ化して表示されます。

項目説明
有効APIが有効/無効であるか
メソッドHTTPメソッド
パスエンドポイントのパス
モデルエンドポイントに紐づいているKurocoのモデル
オペレーションモデルに紐づくオペレーション
サマリーエンドポイント作成時に指定した値
パラメータオペレーション事項時のパラメータ
認証認証方式
[更新]クリックするとエンドポイントの編集ができます
[Pre-processing]クリックするとPre-processingの設定ができます
[Post-processing]クリックするとPost-processingの設定ができます
[削除]クリックするとエンドポイントを削除します

更新履歴の確認

エンドポイントの設定画面からエンドポイントの編集履歴が確認できます。

エンドポイント一覧で、[更新]クリックしてエンドポイントの設定を開きます。

Image from Gyazo

エンドポイントの設定画面の[更新履歴]をクリックすると、エンドポイントの編集履歴が一覧で確認できます。

Image from Gyazo

エンドポイント更新履歴

Image from Gyazo

項目説明
版を表示します。
クリックすると対象の版の状態を確認できます。
更新日時コンテンツが更新された日時を表示します。
更新者コンテンツを更新したメンバー名を表示します。
アクション実行した処理の種類を表示します。
アクションは以下の6種類です。
  • 新規追加
  • 更新
  • 削除
  • 申請
  • 承認
  • 承認差し戻し
コメント更新時に残したコメントを表示します。
内容更新した内容を表示します。

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。