OpenAPI Doğrulayıcısı
YAML veya JSON biçimindeki bir OpenAPI 3.0, 3.1 ya da 3.2 veya Swagger 2.0 belgesini denetleyin ve uç noktalarıyla şemalarının özetini alın. Doğrulayıcı zorunlu alanları, yol şablonlarını yol parametreleriyle eşleştirmeyi, parametre konumlarını, yanıt kodlarını, yinelenen operation ID'leri ve tüm yerel $ref başvurularını denetler; her sorunu konumuyla birlikte listeler.
Sık sorulan sorular
Doğrulayıcı neyi kontrol eder?
openapi veya swagger sürümünü, info.title ve info.version değerlerini, yolların eğik çizgiyle başladığını, bir yoldaki her {parameter} için eşleşen zorunlu bir yol parametresi bulunduğunu ve bunun tersini, parametre adlarını ve konumlarını, yanıt durum kodlarını ve açıklamalarını, yinelenen parametreleri ve operationId değerlerini, ayrıca her yerel $ref başvurusunun belgedeki bir öğeyi gösterdiğini denetler.
Bu, belirtimin tam bir JSON Şeması doğrulaması mı?
Hayır. Elle yazılmış belgelerdeki hataların çoğunu yakalayan yukarıdaki yapısal kuralları denetler; ancak her alanı resmî meta şemaya göre doğrulamaz veya şemalarınızın içeriğini denetlemez.
Özette neler gösterilir?
Belirtim ve API sürümü, başlık; her uç noktanın yöntemini, yolunu, operationId değerini, özetini ve yanıt kodlarını içeren bir tablo; ayrıca components.schemas altındaki şemaların adları veya Swagger 2.0'daki definitions.
Harici başvurular izleniyor mu?
Hayır. Başka dosyalara veya URL'lere yapılan başvurular getirilmez ve raporlanmaz. Yalnızca # ile başlayan başvurular, yapıştırılan belgenin içinde çözümlenir.
Hatalar ile uyarılar arasındaki fark nedir?
Hatalar, eksik yanıt açıklaması veya tanımlanmamış bir yol parametresi gibi belirtim kurallarının ihlal edildiğini gösterir. Uyarılar, istek gövdesi olan bir GET işlemi veya hiç operationId içermeyen bir belge gibi izin verilen ancak genellikle istenmeyen durumları belirtir.
OpenAPI 3.1, zorunlu alanları değiştiriyor mu?
Evet. OpenAPI 3.1 ve 3.2'de bir işlem için artık responses nesnesi gerekmez; bir belgede paths yerine webhooks veya components bulunabilir. openapi alanı 3.1 veya 3.2 ile başlıyorsa doğrulayıcı bu kuralları uygular.