Swagger ペットショップ (本番)

これはペットショップサーバの例です。

Swaggerについてもっと知る、あるいは irc.freenode.net の IRC チャンネル #swagger に参加しましょう。

この例では、認可フィルタの確認用に special-key という API キーを利用できます。

本番環境用の追加の説明文です。

デフォルトリクエスト Content-Type: application/json

デフォルトレスポンス Content-Type: application/json

スキーマ: http

概要

タグ: pet

ペット関連

オペレーション	説明
POST /pets	ペットの追加
PUT /pets	ペットの更新
GET /pets	ペットの検索
GET /pets/{id}	ペットの取得
POST /pets/{id}	ペットの更新
DELETE /pets/{id}	ペットの削除
POST /pets/{id}/photos	ペット写真の追加

タグ: store

店舗関連

オペレーション	説明
GET /store/inventry	状況毎の在庫の確認
POST /store/order	ペットの発注
GET /store/orders/{orderId}	注文の確認

タグ: user

ユーザ関連

オペレーション	説明
POST /users	ユーザの作成
GET /user/login	ログイン
GET /user/logout	ログアウト
GET /users/{name}	ユーザの取得

セキュリティ

api_key

description: 共通鍵による認証を提供します

name: api_key

in: header

petstore_auth

description: OAuth 2.0による認可を提供します

authorizationUrl: http://swagger.io/api/oauth/dialog

flow: implicit

scopes: [object Object]

パス

ペットの検索

GET http://petstore.swagger.io/api /pets

タグ: pet

ユーザがアクセス可能な全てのペットを返します。

注意

タグによる絞り込みしかサポートしていません。


`tags`	絞り込むタグ	query	string[] , comma separated (`tags=aaa,bbb`)
`limit`	結果の上限	query	integer (int32)

デフォルトのContent-Type: application/json

200 OK: ペットエンティティの配列

Pet
default: 想定外のエラー

ErrorModel

ペットの追加

POST http://petstore.swagger.io/api /pets

タグ: pet

店舗にペットを追加します。重複可。

デフォルト Content-Type: application/json

追加するペットオブジェクト

NewPet

application/json

200 OK: 追加されたペットエンティティ

Pet
405 Method Not Allowed: 無効な入力
default: 想定外のエラー

ErrorModel


api_key
petstore_auth	read:pets , write:pets

ペットの更新

PUT http://petstore.swagger.io/api /pets

タグ: pet

既存のペット情報を更新します。

デフォルト Content-Type: application/json

更新するペットオブジェクト

Pet

デフォルトのContent-Type: application/json

400 Bad Request: 無効なIDが与えられた
404 Not Found: ペットが見つからない
405 Method Not Allowed: バリデーション例外
default: 想定外のエラー

ErrorModel


api_key
petstore_auth	read:pets , write:pets

ペットの削除

DELETE http://petstore.swagger.io/api /pets/{id}

タグ: pet

指定されたIDを持つペットエンティティを削除します。


`id`	ID of pet to delete	path	integer (int64)

デフォルトのContent-Type: application/json

204 No Content: pet deleted
default: 想定外のエラー

ErrorModel

ペットの取得

GET http://petstore.swagger.io/api /pets/{id}

タグ: pet

指定されたIDを持つペットエンティティを返します。


`id`	取得するペットのID	path	integer (int64)

デフォルトのContent-Type: application/json

200 OK: ペットエンティティ

Pet
default: 想定外のエラー

ErrorModel


api_key
petstore_auth	read:pets

ペットの更新

POST http://petstore.swagger.io/api /pets/{id}

タグ: pet

フォームからペット情報を更新します。

application/x-www-form-urlencoded


`id`	更新するペットのID	path	integer (int64)
`name`	更新後のペットの名前	formData	string
`status`	更新後のペットの状態	formData	string

デフォルトのContent-Type: application/json

200 OK: ペットエンティティ

Pet
default: 想定外のエラー

ErrorModel


api_key
petstore_auth	write:pets , read:pets

ペット写真の追加

POST http://petstore.swagger.io/api /pets/{id}/photos

タグ: pet

ペットの写真を追加します。

multipart/form-data


`id`	写真を追加するペットのID	path	integer (int64)
`additionalMetadata`	写真の付加情報	formData	string
`file`	アップロードするファイル	formData	file

デフォルトのContent-Type: application/json

200 OK: アップロード成功

ApiResponse
default: 想定外のエラー

ErrorModel


api_key
petstore_auth	write:pets , read:pets

状況毎の在庫の確認

GET http://petstore.swagger.io/api /store/inventry

タグ: store

在庫状況と数量のマップを返します。

デフォルトのContent-Type: application/json

200 OK: 取得成功
400 Bad Request: 無効な注文

ペットの発注

POST http://petstore.swagger.io/api /store/order

タグ: store

ペットを発注します。

デフォルト Content-Type: application/json

ペット購入の注文

Order

デフォルトのContent-Type: application/json

200 OK: 発注成功

Order
400 Bad Request: 無効な注文

注文の確認

GET http://petstore.swagger.io/api /store/orders/{orderId}

タグ: store

ユーザがアクセス可能な全てのペットを返します。

Swagger 側デモAPI (http://petstore.swagger.io/) 利用上の注意

正常なレスポンスを取得するには、 5以上10未満のIDを指定 してください。他の値では例外が発生します。


`orderId`	取得する注文ID	path	integer (int64)

デフォルトのContent-Type: application/json

200 OK: 発注成功

Order
400 Bad Request: 無効な注文

ログイン

GET http://petstore.swagger.io/api /user/login

タグ: user

ユーザをシステムにログインさせます。


`username`	ログインユーザ名	query	string
`password`	ログインパスワード	query	string

デフォルトのContent-Type: application/json

200 OK

成功


X-Rate-Limit	ユーザ毎の最大呼び出し数制限(毎時)	integer (int32)
X-Expires-After	トークンの有効期限(UTC)	string (date-time)

400 Bad Request

無効なユーザ名、またはパスワード

ログアウト

GET http://petstore.swagger.io/api /user/logout

タグ: user

現在ログイン中のユーザセッションをログアウトします。

デフォルトのContent-Type: application/json

default: 成功

ユーザの作成

POST http://petstore.swagger.io/api /users

タグ: user

新規ユーザを作成します。

デフォルト Content-Type: application/json

作成するユーザ

User

デフォルトのContent-Type: application/json

default: 成功

ユーザの取得

GET http://petstore.swagger.io/api /users/{name}

タグ: user

ユーザを取得します。


`name`	取得するユーザ名。テストには `user1` を使ってください。	path	string

デフォルトのContent-Type: application/json

200 OK: 成功

User
400 Bad Request: 無効なユーザ名
404 Not Found: ユーザが見つからない

スキーマ定義

ApiResponse: object

API応答のコンテナ

code: integer (int32)
type: string
message: string

Category: object

カテゴリエンティティ

id: integer (int64): ID
name: string: カテゴリ名

ErrorModel: object

code: integer (int32)
message: string

NewPet: object

新規ペット

category: Category
name: string: 名前
photoUrls: string[]: 写真URL

string
tags: object[]: タグ

Tag
status: string: 店舗におけるペットの状態

Order: object

注文エンティティ

id: integer (int64): ID
petId: integer (int64): ペットID
quantity: integer (int32): 数量
shipDate: string (date-time): 数量
status: string: 注文状況
complete: boolean: 完了しているか？

Pet:

ペットエンティティ

NewPet

id: integer (int64): ID

Tag: object

タグエンティティ

id: integer (int64): ID
name: string: タグ名

User: object

ユーザエンティティ

id: integer (int64)

username: string

ユーザ名

"user1"

firstName: string

名前

"太郎"

lastName: string

名字

"諏訪賀"

email: string

メールアドレス

"foo@example.com"

password: string

パスワード

"pa55w0rd"

phone: string

電話番号

"+81-90-9999-9999"

userStatus: integer (int32)

ユーザ状態