OpenAPI リファレンス

OpenAPI リファレンス

Buda の oRPC コントラクトから直接生成される完全な REST API を参照できます。

ドキュメントのサイドバーから API グループを選ぶと、実際のエンドポイント、リクエストパラメーター、レスポンススキーマ、使用例を確認できます。

このリファレンスは /api/v1/openapi.json と同じコントラクトから生成されるため、ドキュメントと API は常に同期します。

認証

保護されたエンドポイントでは、API キーを Bearer token として使用します。

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://buda.im/api/v1/users/me

関連: REST API ガイド · Swagger UI · OpenAPI JSON

On this page