概要

DrupalでOpenAPIを有効にする機会がありましたので、その備忘録です。なお、以下のjson:apiモジュールを有効化済みです。

モジュールのインストール

以下の2つのモジュールをインストールします。

https://www.drupal.org/project/openapi

https://www.drupal.org/project/openapi_jsonapi

結果、以下のURLで、jsonを取得することができます。

/openapi/jsonapi

以下にアクセスすると、「No UI …」と表示されます。次に、UIを追加してみます。

/admin/config/services/openapi

UIの追加

以下の2つのモジュールをインストールします。

https://www.drupal.org/project/openapi_ui

https://www.drupal.org/project/openapi_ui_redoc

結果、「Explore」のボタンが表示されます。

ボタンをクリックすると、以下の画面に遷移します。

/admin/config/services/openapi/redoc/jsonapi

Swagger UIライクな画面が表示されます。

なお、Redocは、以下のように説明されていました。

Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.

https://github.com/Redocly/redoc

参考

以下の「Swagger UI for OpenAPI UI」についてもインストールしてみましたが、私の環境ではエラーが出てしまいました。

https://www.drupal.org/project/openapi_ui_swagger

まとめ

DrupalでOpenAPIを利用される際の参考になりましたら幸いです。