Nasıl çalışır?
OpenAPI belgesini JSON olarak yükleyip yolları ve HTTP işlemlerini tek listede inceleyin. Belge okunurken eksik tanımlar, tekrar eden işlem kimlikleri ve referanslar için desteklenen kontroller uygulanır. Uyarıdaki yolu izleyerek dikkat gerektiren işlemi bulun. Bu inceleme, bir API taslağını başka bir ekibe devretmeden önce yararlıdır. Uç noktaları çalıştırmak için ayrıca kendi geliştirme veya test ortamınızı kullanmanız gerekir. Bir yol parametresi belgenin hem yol dizgesinde hem işlem tanımında tutarlı yazılmalıdır.
Nasıl kullanılır?
Bir OpenAPI veya Swagger JSON spesifikasyonunu yapıştırın.
Tanınan sürümü ve yol sayısını kontrol edin.
Hataları ve uyarıları gözden geçirin.
HTTP yöntemi ve yolu ile işlem tablosunu inceleyin.
Öne çıkan özellikler
- OpenAPI ve Swagger JSON'u okuyun
- Yolları, işlemleri ve şemaları özetleyin
- Seçilen yapısal kuralları ve yerel referansları kontrol edin
- Liste yöntemleri, yollar, kimlikler ve yanıt kodları
Yöntem ve formüller
Belgenin yapısı okunur. Zorunlu alanlar, yol parametreleri, tekrarlanan kimlikler ve yerel referanslar kontrol edilir. Harici adreslere istek gönderilmez.
Kullanım alanları
- Bir işlem kimliğinin eksik API işlemlerini bul
- Bir spesifikasyonu düzenledikten sonra dahili referansları kontrol edin
- Bir istemci oluşturmadan önce HTTP yollarını ve yöntemlerini gözden geçirin
Uygulamalı örnekler
Örnek hayvan mağazası API’sini inceleme
/pets ve /pets/{petId} yollarını içeren yerleşik OpenAPI 3.0.3 örneğini yükleyin. Rapor 2 yol, 3 işlem ve 1 şema sayar. Eksik operationId ve tanımlanmayan admin etiketi için uyarı verir.
Uyarılar aracın desteklediği denetimlerden gelir.
Sınırlamalar
- • Çalışma alanı JSON'u okur. Yapıştırmadan önce YAML'yi dönüştürün.
- • Araç, seçilen yapısal kuralları kontrol eder ve dış referansları doğrulamaz.
Dosyalarınız ve gizliliğiniz
OpenAPI doğrulayıcı aracına verdiğiniz dosyalar ve bilgiler cihazınızda işlenir.
Tarayıcınız dosyaları bir işlem sunucusuna göndermeden işler.
Microdeck araca girdiğiniz metinleri ve dosyaları kaydetmez. Sayfanın yüklenmesi için internet bağlantısı kullanılır.
Sekmeyi kapatmadan önce saklamak istediğiniz sonuçları indirin veya kopyalayın. Bazı araçlar taslakları tarayıcınıza kaydeder.
Sık sorulan sorular
Bu herhangi bir API uç noktası çağrıştırır mı?
Yapıştırılmış spesifikasyonu okur. İstekler için bir test ortamı kullanın.
Neden operasyon hakkında uyarıyor?
Kimlik bir işlemde yok. Bazı istemci oluşturuculeri adlandırmak için buna güvenir.
Dış referanslara ne oluyor?
Referans kontrolü, yapıştırılmış belgedeki hedeflerle sınırlıdır.