API リファレンス
Paideia LMS は、システムへのプログラムによるアクセスを提供する REST API を提供します。API は OpenAPI 仕様を使用して文書化されており、利用可能なエンドポイント、リクエスト/レスポンススキーマ、認証要件を探索できます。
OpenAPI 仕様
Section titled “OpenAPI 仕様”Paideia LMS は OpenAPI（旧 Swagger）をサポートし、以下の場所で API 仕様を提供します：
/openapi.jsonこのエンドポイントは、Paideia LMS インスタンスでアクセスして、完全な API 仕様を表示できます。OpenAPI 仕様には以下が含まれます：
- 利用可能なすべての API エンドポイント
- リクエストとレスポンススキーマ
- 認証要件
- パラメータの説明
- リクエストとレスポンスの例
OpenAPI 仕様の使用
Section titled “OpenAPI 仕様の使用”OpenAPI 仕様を使用して：
- API クライアントを生成 - OpenAPI Generator などのツールを使用して、お好みのプログラミング言語のクライアントライブラリを作成
- エンドポイントをテスト - Swagger UI や Postman などのツールを使用して API と対話
- 統合を文書化 - 仕様を参照として使用して、Paideia LMS との統合を構築
API へのアクセス
Section titled “API へのアクセス”OpenAPI 仕様は、Paideia LMS インスタンスの /openapi.json で公開アクセス可能です。これにより、開発者とツールは、認証なしで利用可能な API エンドポイントを発見し、理解できます。
実際の API アクセスの場合、Paideia LMS インスタンスで設定された適切な認証方法を使用して認証する必要があります。
OpenAPI 仕様を表示するには、以下を実行できます：
- 直接 URL アクセス：ブラウザで
https://your-paideia-instance.com/openapi.jsonに移動 - curl を使用：
curl https://your-paideia-instance.com/openapi.json - OpenAPI ツール：多くの OpenAPI ツールが URL から直接仕様を取得して解析できます
関連ドキュメント
Section titled “関連ドキュメント”