2014-11-28 18 views

cevap

15

Swagger UI içinde Teşekkür görsel bunları sunar, Swagger şartname dosyalarını alır ve işlemleri yürütmek sağlayan bir araçtır.

Swagger, REST API'lerini belgelemek ve tanımlamak için kullanılan bir belirtimdir. Spesifikasyon burada bulunabilir - https://github.com/swagger-api/swagger-spec/. Depo, belirtimin kendisini, json şemasını, örnekleri ve benzerlerini içerir. Havuzun ana README'si ayrıca, teknik özelliklerinizi üretmek için kütüphaneler ve çerçeveler de dahil olmak üzere ek araçlara işaret eder. o Swagger şartname oluşturmak söz konusu olduğunda

, sen çerçeveler birini kullanmak ve mevcut kodu ile entegre edebilirsiniz söz konusu dokümanları otomatik olarak oluşturun.

Varolan uygulamayı yok doğrusu elle belgelemek ulaşırsa, Swagger-Editör aracını veya seçtiğiniz metin düzenleyici kullanabilirsiniz.

+0

Teşekkür WEBRON, sen havalı –

+0

Ben varolan Swagger API koşu hakkında net görüntü sağlayabilir. Şimdi, Swagger UI'nin API dokümanlarımı gösterebilmesi için ne gerekiyor? Sadece ''/dist/index.html' 'yi açıp swagger api'mize gidiyorum, onu kesmiyor. Swagger.json’a http üzerinden el ile mi hizmet etmek zorundayım? API'mın sadece .json dosyasına hizmet verdiği ekstra bir son noktaya ihtiyacı var mı? Netleştirdiğiniz için teşekkürler. – atripes

+3

Soru, belirsiz ve eksik detaylardır. Burada tam ayrıntılarla yeni bir soru sormayı ya da daha yakından izlenen google grubumuzu kullanmanızı öneriyorum. – Ron

İlgili konular