Skip to main content

​
API を公開する方法

API の公開は endpoint を見せるだけではありません。購入者は API の目的、認証方法、費用、負荷時の挙動を理解する必要があります。

​
購入者導線を準備する

  • API が提供する結果を短く説明する。
  • 動作するリクエスト例を用意する。
  • 認証と必須ヘッダーを文書化する。
  • 制限、よくあるエラー、期待される応答時間を説明する。
  • 購読前に理解できる価格プランを定義する。
最初のページでは、API の役割、対象者、最初のリクエスト、テスト後の費用に答えます。Authentication、Pricing and billing、API referenceを参考にしてください。