← Каталог
Практикум REST и WebSocket — OrderDesk — Фрагмент OpenAPI 3.1 (catalog)
Фрагмент из «Практикум REST и WebSocket — OrderDesk»: Фрагмент OpenAPI 3.1 (catalog).
openapi: 3.1.0
info:
title: OrderDesk Catalog API
version: 1.0.0
servers:
- url: http://localhost:8100
paths:
/api/v1/products:
get:
operationId: listProducts
parameters:
- name: page
in: query
schema: { type: integer, minimum: 1, default: 1 }
- name: pageSize
in: query
schema: { type: integer, minimum: 1, maximum: 100, default: 20 }
responses:
"200":
description: OK
post:
operationId: createProduct
security: [{ bearerAuth: [] }]
responses:
"201":
description: Created
/api/v1/reservations:
post:
operationId: createReservation
security: [{ apiKeyAuth: [] }]
parameters:
- name: Idempotency-Key
in: header
required: true
schema: { type: string, maxLength: 64 }
responses:
"201":
description: Reserved
"409":
description: Insufficient stock
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiKeyAuth:
type: apiKey
in: header
name: X-Api-Key openapi: 3.1.0
info:
title: OrderDesk Catalog API
version: 1.0.0
servers:
- url: http://localhost:8100
paths:
/api/v1/products:
get:
operationId: listProducts
parameters:
- name: page
in: query
schema: { type: integer, minimum: 1, default: 1 }
- name: pageSize
in: query
schema: { type: integer, minimum: 1, maximum: 100, default: 20 }
responses:
"200":
description: OK
post:
operationId: createProduct
security: [{ bearerAuth: [] }]
responses:
"201":
description: Created
/api/v1/reservations:
post:
operationId: createReservation
security: [{ apiKeyAuth: [] }]
parameters:
- name: Idempotency-Key
in: header
required: true
schema: { type: string, maxLength: 64 }
responses:
"201":
description: Reserved
"409":
description: Insufficient stock
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiKeyAuth:
type: apiKey
in: header
name: X-Api-Key