İçe aktarılan bir API'deki sorunları tespit etme

Bir API’yi içe aktardığınızda (OpenAPI, Swagger ve desteklenen diğer biçimler), Restorm API’nin yapılandırılmış belgelerini değişken klasöründe saklar. İçe aktarmadan hemen sonra — ve dosyayı her yeniden açtığınızda — Restorm bu belgeleri sessizce bir tasarıma yansıtır ve tamamen arka planda API tasarımcısının uyguladığı doğrulamanın aynısını çalıştırır. İçe aktarmayı asla engellemez ve yaptığınız işe asla dokunmaz.

Hiçbir şey bulamazsa, hiçbir şey görmezsiniz. Yapısal sorunlar bulursa, bunları size iki yerde gösterir.

Kenar çubuğundaki “!”

İşaretlenen API’yi taşıyan değişken klasörü, satırının sağında küçük bir “!” gösterir. Bu, bu API’nin tasarımında bir bakışta göze çarpan, incelenmeye değer bir şey olduğunun işaretidir — ve API yeniden temiz hale geldiğinde (bir yeniden içe aktarma ya da bunu düzelten bir API güncellemesinden sonra) kendiliğinden kaybolur.

“Sorunlar” sekmesi

Değişken klasörünü açın, bir Sorunlar sekmesi kazansın. Sekme yalnızca sorunlar tespit edildiğinde görünür — temiz bir API onu asla göstermez.

İçe aktarılan bir API'nin değişken klasörünün Sorunlar sekmesi: bir uyarı kutusu, ardından türe göre gruplanmış sorunlar — “Birden fazla rota aynı yönteme ve yola yanıt veriyor”, “Bazı rotalar hiçbir yanıt bildirmiyor”, “Bazı rotalar tasarım sunucusunun ayırdığı bir yolda bulunuyor” — her biri etkilediği tam rotaları listeler, biri o rotanın belgelerini göstermek için genişletilmiş

Sorunlar türe göre gruplanır, böylece yirmi yinelenen rota, yirmi ayrı giriş yerine bir sayaçla tek bir satır olarak görünür. Her türün altında Restorm ilgili tam varlıkları listeler — bir rota, HTTP fiilini ve gerçek yolunu gösterir ve sekmeden ayrılmadan neyi bildirdiğini görebilmeniz için o rotanın belgelerine genişler.

Denetimler API tasarımcısının denetimlerini yansıtır, bu nedenle görebileceğiniz sorun türleri şunları içerir:

yinelenen rotalar — aynı yönteme ve yola yanıt veren iki rota;
eksik yanıtlar — hiçbir yanıt bildirmeyen bir rota;
ayrılmış yollar — Mock Server’ın ayırdığı bir yolda bulunan (/swagger.json, /graphql, …) ve asla yanıt vermeyecek bir rota;
kısıt sorunları — geçersiz bir desen ya da maksimumundan büyük bir minimum.

Liste salt okunurdur: neyi düzeltmeniz gerektiğini söyler ve siz bunu kaynağında düzeltirsiniz (düzeltilmiş bir belirtimi yeniden içe aktarın ya da API’yi düzenleyin). Bir API’yi değiştiren olaylarda yeniden hesaplanır — bir dosya açma, bir içe aktarma, bir API güncellemesi — her tuş vuruşunda değil.