Walidator zgodności API

Do czego służy walidator?

Walidator zgodności API jest narzędziem umożliwiającym sprawdzenie zgodności API Partnerów projektu Otwarte Dane Plus ze standardem.

Partnerami projektu Otwarte Dane Plus są następujące instytucje:

W celu przeprowadzenia walidacji API Partnera, konieczne jest podanie adresu URL prowadzącego do definicji tego API w formacie OpenAPI (na przyklad https://api-dbw.stat.gov.pl/apidocs/pl%201.1.0/dbw.json)

Po wprowadzenia adresu URL definicji w pole "Adres definicji OpenAPI" i naciśnięciu przycisku "Zapisz i rozpocznij sprawdzanie", zostanie przeprowadzony test zgodności API ze standardem technicznym.

Wynikiem testu jest raport, który zostanie wyświetlony na stronie. Będzie on również możliwy do pobrania w formie pliku PDF.

Twoje API

Wypełnij poniższy formularz, podając w nim adres do definicji Twojego API w formacie OpenAPI. Jeżeli do nawiązania połączenia z API jest konieczna dodatkowa konfiguracja, wypełnij odpowiednie pola w sekcji "Zaawansowane".

Wprowadź adres URL do pliku z definicją Twojego API w formacie OpenAPI. Zazwyczaj jest to plik JSON.
Odpowiedzi ze statusem 3xx będą traktowane jak przekierowania
Sprawdzaj poprawność certyfikatu SSL. Błędy certyfikatu przerwą działanie testu.
Włącz tą opcję, jeżeli Twoje API posiada końcówki, które są przetwarzane asynchronicznie