OpenAPI спецификациясы

Жүктеп алу

Postman-ға импорттау

1. Postman-ды ашып, жоғарғы сол жақтағы Import түймесін басыңыз.
2. openapi.yaml файлын сүйреп апарыңыз немесе URL мекенжайын қойыңыз: https://api.fs.ax/openapi.yaml
3. Postman барлық нүктелері, параметрлері және мысал жауаптары бар толық коллекция жасайды.
4. Authorization айнымалысын API кілтіңізге орнатып, тестілеуді бастаңыз.

Клиент жасау

50+ тілде типтелген клиент жасау үшін OpenAPI Generator қолданыңыз:

# Install the generator
npm install -g @openapitools/openapi-generator-cli

# Generate a TypeScript client
openapi-generator-cli generate \
  -i https://api.fs.ax/openapi.yaml \
  -g typescript-fetch \
  -o ./fsax-client

# Generate a Python client
openapi-generator-cli generate \
  -i https://api.fs.ax/openapi.yaml \
  -g python \
  -o ./fsax-python-client

# Generate a Go client
openapi-generator-cli generate \
  -i https://api.fs.ax/openapi.yaml \
  -g go \
  -o ./fsax-go-client

Спецификация алдын ала көрінісі

Міне спецификациядан үзінді:

openapi: "3.1.0"
info:
  title: fs.ax API
  version: "1.0.0"
  description: URL shortener with built-in monetization
  contact:
    email: api@fs.ax
servers:
  - url: https://api.fs.ax/v1
    description: Production
paths:
  /links:
    post:
      summary: Create a short link
      operationId: createLink
      tags: [Links]
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateLinkRequest"
      responses:
        "201":
          description: Link created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"

Көмек қажет пе? API құжаттамасын тексеріңіз немесе api@fs.ax мекенжайына хабарласыңыз.