{"id":14976038,"url":"https://github.com/kibela/kibela-api-v1-document","last_synced_at":"2025-06-25T20:06:55.690Z","repository":{"id":48537797,"uuid":"180312096","full_name":"kibela/kibela-api-v1-document","owner":"kibela","description":"How to use Kibela Web API","archived":false,"fork":false,"pushed_at":"2023-10-02T05:07:40.000Z","size":120,"stargazers_count":65,"open_issues_count":2,"forks_count":5,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-18T01:47:40.540Z","etag":null,"topics":["gaphql-over-msgpack","graphql-api","kibela","kibela-document","kibela-web-api"],"latest_commit_sha":null,"homepage":"https://kibe.la","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kibela.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-09T07:40:25.000Z","updated_at":"2024-11-24T12:03:57.000Z","dependencies_parsed_at":"2023-10-02T06:25:45.906Z","dependency_job_id":"7337eb27-39cf-48a5-aa1a-375ceb0d59bf","html_url":"https://github.com/kibela/kibela-api-v1-document","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kibela/kibela-api-v1-document","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kibela%2Fkibela-api-v1-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kibela%2Fkibela-api-v1-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kibela%2Fkibela-api-v1-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kibela%2Fkibela-api-v1-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kibela","download_url":"https://codeload.github.com/kibela/kibela-api-v1-document/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kibela%2Fkibela-api-v1-document/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261945376,"owners_count":23234237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gaphql-over-msgpack","graphql-api","kibela","kibela-document","kibela-web-api"],"created_at":"2024-09-24T13:53:11.992Z","updated_at":"2025-06-25T20:06:55.646Z","avatar_url":"https://github.com/kibela.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kibela Web API\n\nKibela Web API は、Kibelaのデータにアクセスするツールを開発するためのWeb APIです。他サービスからKibelaへのインポートツールなどを想定しています。\n\n## Table of Contents\n\n\u003c!-- TOC depthFrom:2 anchorMode:github.com --\u003e\n\n- [Table of Contents](#table-of-contents)\n- [概要](#概要)\n- [アクセストークン](#アクセストークン)\n- [エンドポイント](#エンドポイント)\n- [リクエストヘッダ](#リクエストヘッダ)\n  - [JSON](#json)\n  - [MessagePack](#messagepack)\n- [リクエストボディ](#リクエストボディ)\n- [サンプルコード](#サンプルコード)\n- [利用制限](#利用制限)\n  - [1秒あたりのリクエスト数](#1秒あたりのリクエスト数)\n  - [1リクエストごとに消費できるコスト](#1リクエストごとに消費できるコスト)\n  - [1時間ごとに消費できるコスト](#1時間ごとに消費できるコスト)\n  - [コストの計算方法](#コストの計算方法)\n- [ロギング](#ロギング)\n- [リファレンスマニュアル](#リファレンスマニュアル)\n- [フィードバックとバグレポート](#フィードバックとバグレポート)\n- [今後の展望](#今後の展望)\n\n\u003c!-- /TOC --\u003e\n\n## 概要\n\nKibela Web APIは[GraphQL](https://graphql.org/)として提供されています。また、GraphQLの拡張仕様である[Relay GraphQL Server Specification](https://relay.dev/docs/guides/graphql-server-specification/)にも準拠しています。\n\n## アクセストークン\n\n「設定」→「個人用アクセストークン」からアクセストークンを生成してください。ゲスト以外のメンバーは誰でもアクセストークンを生成・使用できます。\n\nhttps://my.kibe.la/settings/access_tokens\n\nそれぞれのアクセストークンには説明を書けます。関連するURL、たとえば該当アクセストークンを利用するツールのリポジトリURLなどをマークダウンで受け付けるようになっています。\n\nアクセストークンは無期限で有効です。不要なアクセストークンは明示的に無効化 (revoke) してください。なお、ユーザーがチームから削除されたときはそのユーザーが作成したアクセストークンはすべて無効化されます。\n\n## エンドポイント\n\n`https://${TEAM_NAME}.kibe.la/api/v1`\n\n`${TEAM_NAME}` はお使いのチーム名にしてください。\n\nこのエンドポイントはPOSTリクエストのみ受け付けます。\n\n## リクエストヘッダ\n\n次のヘッダを指定してください。 `${ACCESS_TOKEN}` はアクセストークンに置き換えてください。\n\n* `Authorization: Bearer ${ACCESS_TOKEN}`\n* `Content-Type: application/json` or `Content-Type: application/x-msgpack`\n* `Accept: application/json` or `Accept: application/x-msgpack, application/json`\n\nまた、`User-Agent` ヘッダは指定することを奨励します。 `User-Agent` はアクセストークンごとの使用履歴（ログ）にも記録されます。\n\n### JSON\n\nリクエストやレスポンスでJSONフォーマットを利用する場合は、リクエストヘッダに `Content-Type: application/json` や `Accept: application/json` を指定してください。\n\n* `Content-Type: application/json`\n* `Accept: application/json`\n\n### MessagePack\n\nリクエストとレスポンスはそれぞれ[MessagePack](https://msgpack.org/)フォーマットも利用できます。\n\nリクエストをMessagePackにする場合は`Content-Type: application/x-msgpack`を、レスポンスをMessagePackにする場合は`Accept: application/x-msgpack, application/json`をそれぞれ指定してください。\n\n* `Content-Type: application/x-msgpack`\n* `Accept: application/x-msgpack, application/json`\n\n現在のところ、エラーレスポンスはJSONを返すことがあります。必ずレスポンスヘッダの`Content-Type`をみてデコードしてください。\n\nMessagePackはバイナリの転送においてオーバーヘッドがなく、また多くのMessagePack処理系においてレスポンスボディのストリーミングデコードが可能であるためJSONよりも遥かに高速にリクエスト・レスポンス処理を行えます。Kibela Web APIを利用するツールは、特に運用フェーズではなるべくMessagePackを使うことを奨励します。\n\nなお、MessagePackを利用する場合、Kibela GraphQL schemaにおける `DateTime` 型はMessagePackのtimestamp typeにマップされます。timestamp typeの詳細についてはお使いのMessagePackシリアライザのドキュメントを参照ください。\n\n## リクエストボディ\n\nリクエストボディには`query`と`variables`を与えてください。`query`パラメータはGraphQL query文字列です。 `variables`はクエリに定義した変数をオブジェクトで与えてください。\n\nこれらのクエリパラメータはGraphQLの仕様に従っています。したがって、任意のGraphQL clientを利用できるはずです。\n\n## サンプルコード\n\nシンプルなサンプルスクリプトは次のリポジトリにあります。\n\n* TypeScript: https://github.com/kibela/hello-kibela.ts\n\nまたcurlを用いたシンプルな例を次に示します。\nお使いのKibelaのサブドメイン名と個人用アクセストークンをセットした上で実行できます。\n\n```bash\nexport SUBDOMAIN='YOUR-SUBDOMAIN'\nexport SECRET='secret/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'\n\ncurl \"https://${SUBDOMAIN}.kibe.la/api/v1\" \\\n  -H \"Authorization: Bearer ${SECRET}\" \\\n  -X POST \\\n  -d '{\"query\": \"query { currentUser { realName } }\", \"variables\": {}}' \\\n  -H 'Accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -H 'User-Agent: KibelaAPITestFromCurl'\n```\n\n## 利用制限\n\nKibela Web APIは過剰な負荷を避けるためにいくつかの利用制限を掛けています。\n\n※ 個々の具体的な制限については現在調整中です。制限は予告なく変更することがあります。\n\n### 1秒あたりのリクエスト数\n\nまず、1秒あたりのリクエスト数です。これは、**1秒につき最大10リクエスト**を超えてはいけません。リクエストを連投するときは最低でも100msあけるようにしてください。この制限をこえるとHTTP status code 429 Too Many Request を返します。\n\n### 1リクエストごとに消費できるコスト\n\n1リクエストごとに最大コストが定められており、これを超えるとレスポンスボディの `errors.extensions.code=REQUEST_LIMIT_EXCEEDED` を返します。HTTP status codeは200です。\n\nエラーレスポンス（抜粋）\n\n```json\n{\n  \"errors\": [\n    {\n      \"extensions\": {\n        \"code\": \"REQUEST_LIMIT_EXCEEDED\",\n      }\n    }\n  ]\n}\n```\n\nこのエラーは再送しても必ず同じエラーを返すので、クエリを組み直してください。\n\n現在、リクエストごとの最大コストは _10,000_ です。この値は予告なく変える可能性があります。\n\n### 1時間ごとに消費できるコスト\n\nまた、1時間ごとに消費できるコストの予算 (budget) がアクセストークンとチームごとに定められており、これを超えると次のエラーになります。\n\n* アクセストークンのバジェット超過: `TOKEN_BUDGET_EXHAUSTED`\n* チームのバジェット超過: `TEAM_BUDGET_EXHAUSTED`\n\nエラーレスポンス（抜粋）\n\n```json\n{\n  \"errors\": [\n    {\n      \"extensions\": {\n        \"code\": \"TOKEN_BUDGET_EXHAUSTED\",\n        \"waitMilliseconds\": 1000,\n      }\n    }\n  ]\n}\n```\n\nこのとき、同じクエリをリクエストするのであれば `waitMilliseconds` だけ待てば再度可能になります。\n\nなお、予算は1msに1回復します。\n\n現在、アクセストークンの1時間ごとの予算は _300,000_ です。また、チームの1時間ごとの予算は _3,000,000_ です。この値は予告なく変える可能性があります。\n\n### コストの計算方法\n\nコストは基本的にGraphQLのフィールド1つにつき1 costです。ただし、1リクエストごとに基本コストが設定されており、かならず基本コスト分消費します。\n\nまた、connectionフィールドはかならず `first` または `last` パラメータで取得数を明示する必要があり、その「取得数 × childre node」がconnection全体のコストになります。\n\n計算されたコストは `Query.budget.cost` クエリでみることができます。\n\nなお、一部のフィールドはコストが通常よりも高いことがあります。たとえば、全文検索やmarkdownのレンダリング（ `contentHtml` など）はコストを高めに設定しています。\n\n消費コストについてはバランスを調整中です。調整が終わったら詳細を公開します。\n\n## ロギング\n\n`query`パラメータの値はログに保存される対象です。このログはチームの管理者にも解放される予定です。秘匿値は`query`パラメータに書かず、`variables`パラメータとして与えてください。\n\n## リファレンスマニュアル\n\nリファレンスマニュアルは現在、「設定」→「個人用アクセストークン」→「Web API console」 (GraphiQL) の \"Documentation Explorer\" から利用できます。\n\nhttps://my.kibe.la/api/console\n\n## フィードバックとバグレポート\n\nこのドキュメントのissuesでフィードバックとバグレポートを受け付けています。起票は日本語ないし英語でお願いいたします。\n\nhttps://github.com/kibela/kibela-api-v1-document/issues\n\n## 今後の展望\n\n将来的に次のような拡張を予定しています。\n\n* OAuth 2.0 への対応\n* Access Token自体の情報をreadonlyでチーム全体に公開するか検討中\n* Web API利用制限・予算管理の調整\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkibela%2Fkibela-api-v1-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkibela%2Fkibela-api-v1-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkibela%2Fkibela-api-v1-document/lists"}