デベロッパー ポータルのトラブルシューティングの概要
API の公開、API に関するデベロッパー トレーニング、デベロッパーのサインアップ、デベロッパーによるアプリ登録のために、API プロバイダには、これらに対応した機能が必要になります。これらのサービスを開発コミュニティに提供するため、Apigee Edge は、カスタマイズされた独自のウェブサイトを構築、リリースできる Developer Services ポータルを提供しています。デベロッパー ポータルの詳細については、デベロッパー ポータルとはをご覧ください。
以下のセクションでは、デベロッパー ポータルの問題をトラブルシューティングする前に理解しておくべき重要なコンセプトについて説明します。
SmartDocs の仕組み
API を記述する OpenAPI 仕様(JSON または YAML)あるいは WADL 仕様を SmartDocs にインポートして、API リファレンス ドキュメントをポータルに公開するために使用できます。API リファレンス ドキュメントは、ポータルの [API] タブの下に自動的に表示されます。デベロッパーはポータルを通じて API ドキュメントを見つけ、ライブ API リクエストを行うことができます。API リクエストはブラウザから発信されるため、リクエストを成功させるには CORS(クロスオリジン リソース シェアリング)のサポートが必要です。CORS サポートは、目的のエンドポイントに対するすべての SmartDocs リクエストのプロキシとして機能する Edge の「smartdocs」プロキシ(「VALIDATE」組織内)によって提供されます。「smartdocs」プロキシは、SmartDocs をインストールすると作成されます。
例:
smartdocs プロキシの URL は、[Configuration] -> [SmartDocs] -> [SmartDocs proxy URL] で構成可能なプロパティとして公開されています。API がプライベート ネットワーク上にあり、ポータルからの SmartDocs を使用したライブ API リクエストが失敗する場合は、この URL の変更が必要な可能性があります。
デベロッパー ポータルが Edge と通信する方法
デベロッパー ポータルは、Smartdocs、デベロッパー、プロダクト、およびデベロッパー アプリを含む Edge から表示されるほとんどの情報を取得して格納します。Edge の組織情報と devadmin 認証情報は、[Configuration] -> [Devportal] のメニュー コマンドを使用して構成できます。
詳細については、ポータルと Edge 間の通信をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2019-01-23 UTC。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"必要な情報がない"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"複雑すぎる / 手順が多すぎる"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"最新ではない"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻訳に関する問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"サンプル / コードに問題がある"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"その他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"わかりやすい"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"問題の解決に役立った"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"その他"
}]
{"lastModified": "\u6700\u7d42\u66f4\u65b0\u65e5 2019-01-23 UTC\u3002"}
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2019-01-23 UTC。"],[],[]]