カスタムログインページ

Apidog では、公開した API ドキュメントをカスタム認証で保護できます。このガイドでは、JWT（JSON Web Token）を使用して既存の認証システムと統合するカスタムログインページの設定方法について説明します。

設定ガイド

ドキュメントサイトの公開範囲設定に移動し、Custom Login Page を選択して、次の 2 つのフィールドに入力します。

JWT Secret: トークンの署名を検証するために使用されます。バックエンドが JWT を発行するときに使用するシークレットと同じである必要があります。このシークレットはご自身で生成する必要があります。

Login URL: ユーザーがオンラインドキュメントサイトにアクセスすると、この URL にリダイレクトされます。このアドレスでログインページをホストし、バックエンドで認証とトークン生成を実装する必要があります。

このログインページは Apidog によって提供されるものではありません。ご自身で構築し、ホストする必要があります。

JWT（JSON Web Token）は、ユーザー認証のためのオープン標準です。ログインシステムは、以下のフローに従う必要があります。

ユーザーが Apidog によって公開されたオンラインドキュメントサイト（例: https://xxxxx.apidog.io）にアクセスします。

システムは、設定済みのログインページ（例: http://localhost:3000）へ自動的にリダイレクトします。

ユーザーが認証情報を入力し、フォームを送信します。

バックエンドがユーザーの認証情報を検証します。

認証に成功すると、バックエンドは設定済みのシークレット（例: pJRdFC3amihQdWbHvUXNZG9WzYdEGHao）を使用して署名された JWT を生成します。

次に、ユーザーをドキュメントサイト（例: https://xxxxx.apidog.io）へリダイレクトし、以下に示すように auth_token という名前のクエリパラメータとしてトークンを含めます。

Apidog はトークンを自動的に検証します。成功した場合、ユーザーはドキュメントのコンテンツにアクセスできます。

ログインフローは、以下の図に示されています。

カスタムログインページを実装する際は、次の要件に注意してください。

JWT 生成: JWT はバックエンドで生成し、Apidog で設定されたシークレットを使用して署名する必要があります。

トークン送信: JWT は、auth_token URL パラメータを介してドキュメントサイトに返す必要があります。

自動検証: Apidog はトークン署名を自動的に解析して検証します。

柔軟なドメイン: ドキュメントサイトの URL は、Apidog が提供するデフォルトのアドレス、または設定したカスタムドメインのいずれでも使用できます。

ログインページにはどの技術スタックを使用できますか？

制限はありません。バックエンドが POST ログインリクエストを処理し、auth_token を含む URL を返せる限り、動作します。Node.js、PHP、Python、Go など、すべてサポートされています。

サンプルプロジェクトはありますか？