OpenAPI-érvényesítő
Ellenőrizzen egy OpenAPI 3.0, 3.1 vagy 3.2, illetve Swagger 2.0 dokumentumot YAML vagy JSON formátumban, és tekintse meg a végpontok és sémák összefoglalóját. Az érvényesítő ellenőrzi a kötelező mezőket, az útvonalsablonokat az útvonalparaméterekkel együtt, a paraméterek helyét, a válaszkódokat, az ismétlődő műveletazonosítókat és minden helyi $ref hivatkozást, majd felsorolja a problémákat a helyükkel együtt.
Gyakran ismételt kérdések
Mit ellenőriz az ellenőrző?
Ellenőrzi az OpenAPI- vagy Swagger-verziót, a info.title és info.version értékeket, hogy az útvonalak perjellel kezdődnek-e, hogy az útvonal minden {parameter} eleme megfelel-e egy kötelező útvonalparaméternek, és fordítva; továbbá a paraméterneveket és -helyeket, a válasz HTTP-állapotkódjait és leírásait, az ismétlődő paramétereket és operationId értékeket, valamint azt, hogy minden helyi $ref hivatkozás a dokumentum egyik elemére mutat-e.
A specifikáció teljes JSON séma szerinti érvényesítését végzi?
Nem. A fent ismertetett szerkezeti szabályokat ellenőrzi, amelyek a kézzel írt dokumentumok legtöbb hibáját kiszűrik, de nem ellenőriz minden mezőt a hivatalos metaséma alapján, és a sémák tartalmát sem vizsgálja.
Mit mutat az összefoglaló?
A specifikáció és a API verzióját, a címet, az összes végpont táblázatát a metódussal, útvonallal, operationId értékkel, összefoglalóval és válaszkódokkal, valamint a components.schemas alatti sémaneveket vagy a Swagger 2.0 definícióit.
Követi a külső hivatkozásokat?
Nem. Más fájlokra vagy URL-ekre mutató hivatkozásokat nem tölt le, és nem is jelzi. Csak a #-tel kezdődő hivatkozásokat oldja fel a beillesztett dokumentumon belül.
Mi a különbség a hibák és a figyelmeztetések között?
A hibák megsértik a specifikáció valamelyik szabályát, például hiányzik a válasz leírása, vagy nincs deklarálva egy útvonalparaméter. A figyelmeztetések megengedett, de rendszerint nem szándékos elemekre utalnak, például GET-művelethez megadott kérés törzsére vagy operationId nélküli dokumentumra.
Az OpenAPI 3.1 megváltoztatja a kötelező elemeket?
Igen. Az OpenAPI 3.1 és 3.2 esetében a művelethez már nem szükséges responses objektum, és az útvonalak helyett webhooks vagy components is szerepelhet a dokumentumban. Az érvényesítő akkor alkalmazza ezeket a szabályokat, ha az openapi mező 3.1 vagy 3.2 értékkel kezdődik.