OpenAPI specifikace

Stáhnout

Import do Postman

1. Otevřete Postman a klikněte na Import vlevo nahoře.
2. Přetáhněte soubor openapi.yaml nebo vložte URL: https://api.fs.ax/openapi.yaml
3. Postman vygeneruje kompletní kolekci se všemi endpointy, parametry a ukázkovými odpověďmi.
4. Nastavte proměnnou Authorization na svůj API klíč a začněte testovat.

Generování klienta

Použijte OpenAPI Generator k vytvoření typovaného klienta v 50+ jazycích:

# 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

Náhled specifikace

Zde je ukázka ze specifikace:

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"

Potřebujete pomoc? Podívejte se na API dokumentaci nebo nás kontaktujte na api@fs.ax.