Generator OpenAPI

Dokumentacja API według standardu

Bezpieczne (SSL)

Przetwarzanie Lokalne

100% Darmowe

Przejdź do narzędzia

Instrukcja

1

Wprowadź dane
Wpisz treść, wklej tekst lub załaduj plik z dysku.
2

Kliknij przycisk
Narzędzie natychmiast przetworzy Twoje dane w przeglądarce.
3

Pobierz wynik
Skopiuj gotowy tekst lub zapisz plik na urządzeniu.

                                                function runTool() {

                                                  return "Wynik gotowy w 0.1s";

                                                }

Tytuł API

Wersja

URL serwera

Autoryzacja

Endpointy (METODA; ścieżka; opis)

Opis API

openapi.yaml

openapi: 3.0.3
info:
  title: My API
  version: 1.0.0
  description: Opis API
servers:
  - url: "https://api.example.com"
security:
  - bearerAuth: []
paths:
  /users:
    get:
      summary: Lista użytkowników
      responses:
        '200':
          description: Sukces
        '400':
          description: Błąd żądania
    post:
      summary: Utworzenie użytkownika
      responses:
        '200':
          description: Sukces
        '201':
          description: Utworzono
        '400':
          description: Błąd żądania
  /users/{id}:
    get:
      summary: Szczegóły użytkownika
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sukces
        '400':
          description: Błąd żądania
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Specyfikację możesz zaimportować do Swagger UI, Postmana lub wygenerować z niej klienta. Ścieżki z parametrami {id} otrzymują automatycznie parametr path.

Oceń to narzędzie:

Powiązane narzędzia

Inne narzędzia, które mogą Ci się przydać

Generator specyfikacji OpenAPI

OpenAPI to standard opisu API REST. Na jego podstawie generuje się dokumentację (Swagger UI), klientów SDK i testy kontraktowe.

Struktura specyfikacji

Sekcja	Opis
info	tytuł, wersja, opis
servers	adresy API
security	sposób autoryzacji
paths	endpointy i ich odpowiedzi

Format endpointów

Każdy endpoint to METODA; ścieżka; opis, np. GET; /users; Lista użytkowników. Ścieżki z {id} otrzymują parametr path.

Autoryzacja

Bearer — token JWT w nagłówku Authorization.
API Key — klucz w nagłówku (np. X-API-Key).

Najczęstsze pytania

Gdzie wkleić specyfikację?

Do pliku openapi.yaml. Swagger UI wyrenderuje dokumentację, a generator klientów utworzy SDK.

Czym OpenAPI różni się od Swaggera?

Swagger to starsza nazwa specyfikacji (2.0). OpenAPI 3.x to jej nowsza wersja, a Swagger UI to narzędzie do jej prezentacji.

Czy opis jest kompletny?

To solidny szkielet — dodaj schematy requestów i odpowiedzi (components.schemas), aby uzyskać pełną dokumentację.

Generator OpenAPI

Powiązane narzędzia

Generator specyfikacji OpenAPI

Struktura specyfikacji

Format endpointów

Autoryzacja

Najczęstsze pytania

Zobacz też — powiązane narzędzia