v3.1.0APIs & Backend

OpenAPI Integration

VelinScript kann automatisch OpenAPI Specifications (Swagger) aus deinem Code generieren.

Verwendung (CLI)

Nutze das velin-api-doc Tool, um Spezifikationen zu exportieren.

# Standard JSON Generierung
velin-api-doc generate -i main.velin -o api.json

# YAML Format
velin-api-doc generate -i main.velin -o api.yaml --format yaml

# Markdown Dokumentation
velin-api-doc generate -i main.velin -o api.md --format markdown

# Mit Custom Metadaten
velin-api-doc generate -i main.velin -o api.json --title "My API" --version "1.0.0"

Beispiel

VelinScript Code

@GET("/api/users/:id")
@Auth
fn getUser(id: string): User {
    return db.find(User, id);
}

@POST("/api/users")
fn createUser(name: string, email: string): User {
    // ...
}

Generierte OpenAPI Spec (Auszug)

{
  "openapi": "3.0.0",
  "info": {
    "title": "VelinScript API",
    "version": "1.0.0"
  },
  "paths": {
    "/api/users/{id}": {
      "get": {
        "operationId": "get_user",
        "security": [{"bearerAuth": []}],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        }
      }
    }
  }
}

Kern-Features

Auto-Detection

HTTP Endpoints und Pfad-Parameter werden automatisch extrahiert.

Security Mapping

Decorators wie @Auth werden zu Security Requirements.

Integrationen

Die generierte Spezifikation ist kompatibel mit dem gesamten OpenAPI Ökosystem:

  • Dokumentation: Swagger UI, ReDoc
  • Client-Generierung: OpenAPI Generator (SDKs für 50+ Sprachen)
  • Testing: Postman, Insomnia Import
  • Gateways: AWS API Gateway, Kong, Tyk
FrameworksAPI Dokumentation