このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge ドキュメントを表示する
公開とは、アプリ デベロッパーが API を使用できるようにするプロセスです。
動画: 次の動画では、API 公開の概要について説明します。
API を公開する場合は、このトピックで説明する次のタスクを実行する必要があります。
- API をバンドルする API プロダクトの作成。
- アプリ デベロッパーの登録。
- デベロッパーのアプリの登録。
- API に関するドキュメントとコミュニティ サポートの提供。
タスク 1: API プロダクトの作成
公開の最初のタスクでは、API プロダクトを作成します。API プロダクトとは、アプリ デベロッパーが使用できるように、パッケージとして提供される API リソースを集めたものです。Apigee API または UI を使用して API プロダクトを作成します（API プロダクトの詳細については、API プロダクトとはをご覧ください）。
この図では、API は 2 つのプロダクトから構成されており、それぞれ 3 つの API リソースが含まれています。
API プロバイダは、API と API プロダクトを構築し、アクセス制御、使用制限、その他のビジネス要件に対応します。たとえば、以下のことができます。
- API リソースの読み取り専用アクセスが可能な無料の API プロダクトをリリースする。
- 2 番目の低価格の API プロダクト（無料バージョンと同じ API リソースの読み取り / 書き込みアクセスが可能だが、1 日 1,000 リクエストなど、アクセスの上限が低く抑えられている）をリリースする。
- 3 番目の高価格の API プロダクト（同じ API リソースへ、読み取り / 書き込みアクセスが可能だが、アクセス上限が高く設定されている）をリリースする。
Apigee を使用すると、API のビジネス要件に合った API プロダクトを柔軟に作成できるという点が重要です。
API プロダクトの作成の詳細については、API プロダクトを管理するをご覧ください。
タスク 2: アプリ デベロッパーの登録
デベロッパーは、API を使用するアプリを作成します。アプリ デベロッパーは、Apigee に登録すると、アプリを登録できるようになります。アプリが登録されると、アプリに API へのアクセス権を付与する API キーを受け取ります。
このアプリ登録プロセスを通して、API にアクセスできるユーザーを制御します。アプリ デベロッパーはいつでも削除できますが、削除したデベロッパーに関連付けられているすべての API キーが無効になるため、そのデベロッパーが API にアクセスすると拒否されます。
API プロバイダは、デベロッパーを登録する方法を決定します。たとえば、手動登録プロセスを使用すると、これから登録するデベロッパーは組織とコンタクトを取って登録する必要があります。このデベロッパーは、メールアドレス、姓名など、必要なすべての情報を指定する必要があります。デベロッパーの申請が承認されると、Apigee UI を使用して手動で登録できます。詳細については、アプリ デベロッパーの登録をご覧ください。
タスク 3: デベロッパーのアプリの登録
アプリが API にアクセスする前に、アプリを登録する必要があります。ただし、アプリを登録できるのは登録済みのデベロッパーのみです。
アプリの登録時にデベロッパーは 1 つ以上の API プロダクトを選択します。たとえば、さまざまな種類のサービスや料金プランに対応する複数の API プロダクトを公開できます。アプリ デベロッパーは、利用可能な API プロダクトのリストから選択できます。
アプリを Apigee に登録すると、Apigee により一意の API キーがアプリに割り当てられます。アプリは、API リソースへの各リクエストにこの API キーを入れて渡す必要があります。キーが有効な場合は認証され、リクエストが認められます。サービス プロバイダは、キーをいつでも取り消すことができ、そうすると、アプリは API にアクセスできなくなります。
API プロバイダは、アプリの登録方法を決定します。以下の方法をお試しください。
- 手動プロセスを使用すると、デベロッパーは組織とコンタクトを取ってそのアプリを登録する必要があります。それに対して、通常はメールで API キーを送信します。
- Apigee API を使用して、アプリの登録機能とキー配信をウェブサイトに統合します。
- 有料の Apigee アカウントの場合、アプリ登録と API キー配信のサポートが組み込まれた Apigee Developer Services ポータルを使用します。
詳細については、アプリの登録と API キーの管理をご覧ください。
タスク 4: API のドキュメント化
API プロダクトを公開する場合は、ドキュメントとデベロッパーのフィードバック メカニズムについて考慮することが重要になります。ソーシャルな公開機能を備えたデベロッパー ポータルは、開発コミュニティとのコミュニケーションにだんだんと使用されるようになっています。これには、API ドキュメントや利用条件などの静的コンテンツ、ブログやフォーラムなどのコミュニティ投稿型の動的コンテンツ、カスタマー サポート機能などがあります。
ドキュメントは、独自のウェブサイトを構築してデプロイできます。あるいは、有料の Apigee アカウントをお持ちの場合は、Apigee Developer Services ポータルを使用できます。ポータルには、ドキュメント、ブログ、フォーラムなど、デベロッパー コミュニティのサポートに必要なコンテンツに対するサポートも組み込まれています。
SmartDocs を使用すると、Developer Services ポータルで API を完全な対話型のドキュメントにすることができます。SmartDocs による対話型のドキュメントにより、ポータル ユーザーは次の操作が可能になります。
- API に関する情報の確認
- API へのライブ リクエストの送信
- API から返された実際のレスポンスの表示
詳しくは、次のセクションをご覧ください。
- 統合ポータル: API の公開
- Drupal 10: API のドキュメント作成