Menu Close

第2章 API の公開

本章では、Red Hat 3scale API Management を使用して API を公開するための主要な手順について説明します。本章で説明する手順は、以下の状況を前提をしています。

  • 3scale に内部 API API Backend (backend を参照) が設定されている。
  • 3scale に顧客がアクセスする API Echo API (product を参照) が設定されている。これが、デベロッパーポータルを通じて公開される API です。

本章では、API プロダクトを公開するための以下の手順を説明します。

  1. プロダクトを保護する。
  2. アプリケーションプランを使用してプロダクトへのアクセスポリシーを設定する。
  3. デベロッパーポータルを通じて開発者を参加させる。
  4. 実稼働環境に移行する。

2.1. 最初の API を公開するためのパス

3scale の操作を開始するにあたり、API プロダクトを一般に公開する 3 つのパスのいずれかを選択することができます。API プロダクト とは、一般に公開され顧客がアクセスする API です。

期間のガイドラインは、API プロダクトの複雑さや作業に割くことのできるリソースにより異なります。ほとんどの時間は、API プロダクトの調整およびデベロッパーポータルコンテンツの準備に費やされます。安定したプロダクトおよびドキュメントのコンテンツがすでに用意されている場合には、1 週間で実稼働環境に移行することができます。

最初の API プロダクトを公開するためのパスを以下に示します。

プロトタイプ

  • 目的: 3scale と一般に公開されるシンプルな API プロダクトのインテグレーションを、エンドツーエンドで完了する。
  • 対象: このパスは、3scale のエンドツーエンドの機能を大まかに理解するのに役立ちます。ベーシックの手順を実施する前に、このパスを実施する必要があります。管理ポータルの導入ウィザードを正常に完了している場合には、このパスを省略して次のパスに進むことができます。
  • 所要時間: 1 時間以内

ベーシック

  • 目的: API プロダクトを実稼働環境で公開するための操作手順をすべて完了する。
  • 対象: API プロダクトを実稼働環境で公開したいが時間が限られている場合には、このベーシックパスにより必要な操作のほとんどがカバーされます。
  • 所要時間: 1 週間以内

アドバンスト

  • 目的: ベーシックパスを完了した後のオプション操作。API プロダクトの高度なコントロールおよびデベロッパーポータルの複雑なカスタマイズが可能。
  • 対象: 要求がより複雑である、またはベーシックパスをすでに完了している場合には、アドバンストのオプションの検討が必要な場合があります。
  • 所要時間: 数週間