Softonic

Walidator Swagger 2.0

Krok 1 / 2
Dalej

Wklej definicję Swagger 2.0 w formacie JSON lub YAML, aby sprawdzić, czy ma pole wersji swagger, obiekt info z title i version oraz obiekt paths. Wpisy ścieżek są sprawdzane pod kątem wiodącego ukośnika i kluczy, które nie są standardowymi operacjami.

Jak sprawdzić plik Swagger 2.0

  1. 1

    Skopiuj definicję

    Skopiuj cały plik `swagger.json` lub `swagger.yaml`, zaczynając od linii `swagger: "2.0"`.

  2. 2

    Wklej ją

    Wklej ją w pole dokumentu OpenAPI / Swagger.

  3. 3

    Uruchom sprawdzenie

    Przejdź do kroku wyników, aby zobaczyć błędy i ostrzeżenia.

  4. 4

    Zaktualizuj i sprawdź ponownie

    Zastosuj poprawki w swoim pliku i wklej nową wersję, aż raport będzie czysty.

Co uznaje się za zaliczenie dla Swagger 2.0

W pliku 2.0 kontrola wersji jest spełniona przez klucz swagger na najwyższym poziomie. Narzędzie nie sprawdza, czy wartość to "2.0", więc nie wychwyci błędnego numeru. Poza wersją wymagane są info.title, info.version i obiekt paths.

Pola specyficzne dla Swagger 2.0, takie jak host, basePath, schemes, definitions i securityDefinitions, nie są badane. Brakujący host albo uszkodzony blok definitions nie zostanie zgłoszony.

Przykład krok po kroku

{
  "swagger": "2.0",
  "info": { "title": "Shop API", "version": "1.0" },
  "paths": {
    "/products": {
      "get": { "summary": "List products" },
      "x-internal": true
    }
  }
}

Pole wersji, info i paths są obecne, więc nie ma błędów. Raport pokazuje jedno ostrzeżenie:

Wynik Typ Dlaczego
Unknown method ‘x-internal’ on /products. Ostrzeżenie Klucz nie jest standardową operacją ani polem elementu ścieżki

Dokument nadal jest uznany za poprawny, bo ostrzeżenia nie blokują poprawności. Klucze rozszerzeń dostawcy, takie jak x-internal, są w Swagger 2.0 dozwolone, więc możesz je zostawić.

Migracja z wersji 2.0

Jeśli planujesz przejście na OpenAPI 3.x, możesz wkleić przekonwertowany plik w to samo pole i porównać wyniki. Kontrola jest ta sama, z tym że pole openapi zastępuje swagger. Do właściwej migracji potrzebujesz pełnego konwertera i lintera, bo to narzędzie nie tłumaczy ustawień definitions ani host.

Kiedy szybka kontrola wystarcza

Definicje Swagger 2.0 często istnieją w repozytoriach przez lata i są edytowane ręcznie. Szybka kontrola strukturalna jest przydatna, gdy przejmujesz taką definicję, gdy narzędzie odmawia jej wczytania i podejrzewasz brakujące pole albo gdy łączysz dwa pliki i chcesz mieć pewność, że wynik nadal ma sekcje info i paths. Pełne reguły dla 2.0, w tym definitions i ustawienia zabezpieczeń, sprawdź dedykowanym linterem.

Pamiętaj, że czysty raport mówi wyłącznie o strukturze. Operacje bez odpowiedzi, błędne typy parametrów i nierozwiązane referencje leżą poza tą kontrolą, więc przetestuj plik także w swoim narzędziu do dokumentacji lub generowania kodu.

Najczęściej zadawane pytania

Nie. Sprawdza, czy pole swagger lub openapi istnieje, a nie co zawiera.

Nie. Sprawdzane są tylko pole wersji, obiekt info, obiekt paths i wpisy pod każdą ścieżką.

Tak. Tekst jest najpierw odczytywany jako JSON, a jeśli to się nie uda, jako YAML. Przy wklejaniu zachowaj wcięcia bez zmian.

Pola na poziomie ścieżki parameters, summary, description i servers znajdują się na liście akceptowanych kluczy, więc nie uruchamiają ostrzeżenia o nieznanej metodzie.

Powiązane narzędzia

Generator konfiguracji webpack

Utwórz plik webpack.config.js dla webpacka 5 do czystego JavaScriptu, Reacta lub Vue: TypeScript, Babel, CSS lub Sass, obrazy, HtmlWebpackPlugin, serwer deweloperski i polecenie npm install.

Generator kolorów analogicznych

Twórz pięciokolorowe palety analogiczne z dowolnego koloru bazowego: klasyczną trójkę, dwie zewnętrzne barwy oraz wartości hex, RGB i HSL.

Walidator XSD

Waliduj dokument XML wobec schematu XSD i zgłaszaj niezgodności elementów i typów z dokładnymi numerami wierszy.

Generator fikcyjnych numerów telefonu

Generuj do 50 fikcyjnych numerów z oficjalnie zastrzeżonych zakresów w pięciu krajach.

Kod na obraz

Wklej kod, ustaw motyw, kolory, rozmiar czcionki, odstępy, nagłówek i numery wierszy, sprawdź podgląd canvas i pobierz PNG. Renderowanie zwykłego tekstu, bez podświetlania składni.

Dekoder Protocol Buffers

Dekoduj lokalnie bajty Protobuf z zapisu hex, Base64, Base64URL, tekstu lub pliku, analizuj pola i eksportuj prywatny raport.

Narzędzie jest dostępne w innych językach

Poradniki i zastosowania