ペットショップ API の概要
このドキュメントは、サンプルであるペットショップサーバーの API リファレンスを提供します。ここに記載されているリクエストを利用することで、開発者はペットショップサーバーに対して呼び出しを行い、システムに登録されたペットや注文に関するデータの送信や取得を行うことができます。
ペットショップ API を使用すると、開発者は以下の操作を行うことができます：
ペット
- データベース内のペットを作成、読み取り、更新、削除する。
- ペットの画像をアップロードする。
- ステータス（在庫あり、保留中、販売済み）、タグ、または一意の識別子でペットを検索する。
店舗
- ステータス別に分類されたペットの在庫を取得する。
- ペットの注文を行う。
- IDで注文書を検索する。
- 注文をキャンセルする。
ユーザー
- 新しいユーザーアカウントを作成する（個別またはリストから）。
- ユーザーのログインおよびログアウトを行う。
- ID に基づいてユーザーを検索する。
- ユーザー名に基づいてユーザー情報を取得、更新、削除する。
この例では、犬（Krypto）と ID 番号 210 を使用します。
接続の前提条件
すべてのAPIリクエストのベースURLは https://petstore3.swagger.io/api/v3 です。
認証
PetstoreのAPIへの接続を認証するには、OAuth 2.0または割り当てられたAPIキーを使用してください。キーをリクエストするには、budbaker@bhavenpets.com までメールでお問い合わせください。
注記
セキュリティ上の理由から、APIキーを他のユーザーと共有しないでください。APIキーのセキュリティ侵害が疑われる場合は、直ちに管理者に連絡し、古いキーを無効にして新しいキーを発行してもらってください。