OpenAPI Spec

Herunterladen

In Postman importieren

1. Postman öffnen und oben links auf Import klicken.
2. Die Datei openapi.yaml per Drag & Drop hinzufügen oder die URL einfügen: https://api.fs.ax/openapi.yaml
3. Postman generiert eine vollständige Sammlung mit allen Endpunkten, Parametern und Beispielantworten.
4. Die Authorization-Variable auf Ihren API-Schlüssel setzen und mit dem Testen beginnen.

Einen Client generieren

OpenAPI Generator verwenden, um einen typisierten Client in über 50 Sprachen zu erstellen:

# 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

Spezifikations-Vorschau

Hier ist ein Ausschnitt der Spezifikation:

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"

Hilfe benötigt? Lesen Sie die API-Dokumentation oder wenden Sie sich an api@fs.ax.