Swagger для тестировщика

Swagger (OpenAPI) — это стандарт для документирования API. Он описывает все доступные эндпоинты, методы, параметры и модели данных. Этот симулятор поможет вам понять структуру Swagger-документации на примере Petstore API.

Base URL: petstore.swagger.io/v2

pet Everything about your Pets

POST
/pet
Add a new pet to the store

Тело запроса (Request Body)

Для создания нового питомца отправьте JSON-объект, соответствующий схеме 'Pet'.

Pet {
id: integer,
name: string // required,
status: string
}
Simulated Response
POST /pet

Responses

200 OK - Успешное создание.
400 Invalid input - Некорректные данные в запросе.
PUT
/pet
Update an existing pet

Тело запроса (Request Body)

Для обновления питомца отправьте JSON с его ID.

Pet {
id: integer // required,
name: string // required,
status: string
}
Simulated Response
PUT /pet

Responses

200 OK - Успешное обновление.
400 Invalid ID supplied - Некорректный ID.
404 Pet not found - Питомец не найден.
GET
/pet/{petId}
Find pet by ID

Параметры (Parameters)

petId
integer
Simulated Response
GET /pet/123

Responses

200 OK - Успешный поиск.
404 Pet not found - Питомец не найден.
DELETE
/pet/{petId}
Deletes a pet

Параметры (Parameters)

petId
integer
Simulated Response
DELETE /pet/123

Responses

200 OK - Успешное удаление.
404 Pet not found - Питомец не найден.

store Access to Petstore orders

GET
/store/inventory
Returns pet inventories by status
Simulated Response
GET /store/inventory

Responses

200 OK - Успешно. Возвращает объект с количеством питомцев по статусам.

user Operations about user

POST
/user
Create user

Тело запроса (Request Body)

Для создания пользователя отправьте JSON-объект.

User {
username: string,
firstName: string,
lastName: string,
email: string,
password: string
}
Simulated Response
POST /user

Responses

200 OK - Успешное создание.

Models Схемы данных, используемые в API

Pet

Pet {
id: integer,
category: Category,
name: string,
photoUrls: [ string ],
tags: [ Tag ],
status: string
}

Order

Order {
id: integer,
petId: integer,
quantity: integer,
shipDate: dateTime,
status: string,
complete: boolean
}