ここでは、Python 用 Endpoints Frameworks の使用を開始する際に役立つ、ライブラリとツールについて説明します。また、その他の有用な情報も提供します。Endpoints Frameworks のアーキテクチャの概要については、Endpoints Frameworks についてをご覧ください。
ライブラリとツール
App Engine スタンダード環境用 Cloud Endpoints Frameworks には、次のライブラリとツールが用意されています。
- フレームワーク ライブラリ。
endpointscfg.py
コマンドライン ツールを使用して、以下を生成します。- クライアント ライブラリ バンドルとディスカバリ ドキュメント。これにより、Android アプリやその他のタイプのクライアント アプリケーションから API にアクセスできます。
- OpenAPI 構成ファイル。このファイルは、モニタリング、ロギング、API キー検証などの API 管理機能が必要な場合に使用します。
要件
Endpoints Frameworks を使用するには、チュートリアルの手順に従ってください。
JavaScript ウェブ クライアントや、Android などのモバイル クライアントといったクライアントの開発方法を把握する必要があります。
開発プロセス
Endpoints Frameworks を使用してアプリケーションを開発するための一般的なワークフローは次のとおりです。
- まず、API のコードを作成します。クラスと公開メソッド(ある場合)をラップし、
Message
クラスを作成します。Endpoints API の作成をご覧ください。 - API を提供するウェブサーバーを作成します。
- OpenAPI 構成ファイルを生成して、チュートリアルの手順に沿ってデプロイします。
- 必要に応じて、API をローカルでテストします。
- API をデプロイします。
- クライアント ライブラリを生成します。
- クライアント アプリケーションを作成します。その際、API 呼び出しを行う場合はクライアント ライブラリを使用します。
はじめに
開始するには、チュートリアルに従ってサンプル API を構成、デプロイし、リクエストを送信します。次に、このセクションに戻って、独自の API を構成、デプロイ、およびテストするために必要な情報を確認してください。
Endpoints バージョン 1.0 からの移行
前のバージョンの Endpoints を使用して API バックエンドをすでに開発している場合には、移行ガイドの手順に従ってアプリを Endpoints バージョン 2.0 に移行してください。