OpenAPI

GitLabは、OpenAPI 3.0仕様（以前はSwaggerと呼ばれていました）を使用してREST APIをドキュメント化しています。これは、RESTful APIを記述するための標準的でプラットフォームに依存しない仕様です。APIコードは、REST APIの信頼できる唯一の情報源です。OpenAPI specは、APIコードから直接自動生成され、その実装と密接に結合されているため、ドキュメントは常に正確で最新の状態に保たれます。

GitLab APIの一般的な情報については、GitLabを使用して拡張するを参照してください。

OpenAPI仕様ファイル

raw OpenAPI 3.0仕様は、GitLabモノレポで入手できます:

• ファイル: doc/api/openapi/openapi_v3.yaml
• 形式： OpenAPI 3.0 (YAML)

対話型REST APIドキュメント

REST APIは、OpenAPI 3.0仕様を使用して完全にドキュメント化されています。REST APIドキュメントで、すべてのエンドポイントを対話的に参照およびテストできます。

ドキュメントは、スカラー（オープンソースのAPI参照ツール）を使用してレンダリングされます。これはGitLabのソースコードにあるOpenAPI specから自動的に生成されるため、常にAPIの現在の状態を反映しています。

認可認証情報を追加します

一部のエンドポイントには認証が必要です。GitLabは、HTTP BearerまたはOAuth 2.0認証情報による認証をサポートしています。

認可認証情報を追加するには:

1. REST APIドキュメントにアクセスします。
2. 右側の認証パネルで、ドロップダウンリストから認証方法を選択します。
3. 認証情報を入力します:
   • httpの場合は、パーソナルアクセストークンを入力します。
   • oauth2の場合は、GitLabをIdentity Providerとして認可フローを使用します。
4. 認証を選択します。

セッション中は、認証情報が後続のすべてのリクエストに自動的に再利用されます。

ライブリクエストを送信

対話型リクエストツールを使用して、ライブリクエストをGitLabに送信します。

ライブリクエストを送信するには:

1. REST APIドキュメントにアクセスします。
2. オペレーションを展開する。
3. Test Requestを選択します。
4. 必須またはオプションのパラメータを入力します。
5. 送信を選択します。

このツールは、curlコマンド、完全なリクエストURL、およびサーバー応答を表示します。