【Strapi】SwaggerのテストURLを変更する

こんにちは、フリーランスエンジニアの太田雅昭です。

StrapiにはDocumentationというプラグインがあり、そこでAPIのテストを行ったりすることができます。

テスト用のURLを変更する

SwaggerはデフォルトでURLがlocalhostとなっています。これに新しいURLを足したり、変更したりするには、/config/plugins.tsファイルに以下の記述を足します。

module.exports = ({ env }) => ({
    ...

    documentation: {
        config: {
            servers: [
                {
                    url: env('API_URL', 'http://localhost:1337'),
                    description: 'Development server',
                },
            ],
        }
    },
});

ここではAPI_URL環境変数を読み込んでいますが、もちろん直接記述することもできます。また複数指定すれば、ページ表示時にどれかを選択できるようになります。便利ですね。

他の設定項目は以下に書かれています。

Documentation | Strapi Documentation

By using Swagger UI, the API documentation plugin takes out most of your pain to generate your documentation.

ではでは。