API docs by Redocly

Swagger Petstore (1.0.1)

Download OpenAPI specification:Download

API Support: apiteam@swagger.io URL: https://github.com/Redocly/redoc License: Apache 2.0

これはテスト用の Petstore server です。

Introduction

This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team.

pet

Everything about your Pets

ペット情報の取得

ペット情報を取得します。

Authorizations:
api_key
path Parameters
petId
required
integer <int64>
Deprecated

ペットID

Responses

ペットの追加

新しいペットを追加します。

cookie Parameters
cookieParam
required
integer <int64>

クッキーパラメータ

header Parameters
Accept-Language
string
Default: en-AU
Example: en-US

許可する言語

Responses

Request samples 

PetStore.v1.Pet pet = new PetStore.v1.Pet();
pet.setApiKey("your api key");
pet.petType = PetStore.v1.Pet.TYPE_DOG;
pet.name = "Rex";
// set other fields
PetStoreResponse response = pet.create();
if (response.statusCode == HttpStatusCode.Created)
{
  // Successfully created
}
else
{
  // Something wrong -- check response for errors
  Console.WriteLine(response.getRawResponse());
}

store

Access to Petstore orders

user

Operations about user

ユーザー管理の権限チェック

ユーザー管理が使用可能かチェックします。

利用者の作成

利用者を作成します。

Request Body schema: application/json
required

作成する利用者情報

username
string >= 4 characters

氏名

email
string <email>

メールアドレス

password
string <password> >= 8 characters /(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/

ログインパスワード、８文字以上の英数字

userStatus
integer <int32>

利用者のステータス

Responses

Request samples

Content type
application/json
{
  • "username": "John78",
  • "email": "john.smith@example.com",
  • "password": "drowssaP123",
  • "userStatus": 0
}

利用者の削除

利用者を削除します。

path Parameters
username
required
string

削除する利用者名

Responses

利用者情報の取得

利用者の情報を取得します。

path Parameters
username
required
string

情報を取得する利用者名

Responses

Response samples

Content type
{
  • "username": "John78",
  • "email": "john.smith@example.com",
  • "password": "drowssaP123",
  • "userStatus": 0
}