Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

78.3. API ドキュメントにセキュリティー定義を追加する

Rest DSL は、生成された API ドキュメントで OpenApi securityDefinitions を 宣言することをサポートするようになりました。例えば、以下のように。 

rest("/user").tag("dude").description("User rest service")
    // setup security definitions
    .securityDefinitions()
        .oauth2("petstore_auth").authorizationUrl("http://petstore.swagger.io/oauth/dialog").end()
        .apiKey("api_key").withHeader("myHeader").end()
    .end()
    .consumes("application/json").produces("application/json")

ここでは、2 つのセキュリティー定義を設定しました。

  • OAuth2 - 提供された URL で暗黙の認証を行います。
  • Api Key - myHeader という HTTP ヘッダーに由来する Api Key を使用します。

そして、残りの操作で、どのセキュリティーを使用するか、そのキー (petstore_auth または api_key) を参照して指定する必要があります。 

.get("/{id}/{date}").description("Find user by id and date").outType(User.class)
    .security("api_key")

...

.put().description("Updates or create a user").type(User.class)
    .security("petstore_auth", "write:pets,read:pets")

ここでは、get 操作には Api Key のセキュリティーが、put 操作には OAuth のセキュリティーが、許可されたスコープとして read と write のペットが使用されています。

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hatトップに戻る