OpenAPI Markdown Belgeleri

OpenAPI Markdown Belgeleri

Bir OpenAPI 3 veya Swagger 2 belgesini yapıştırın — JSON veya YAML formatında — ve bu araç bunu bir README dosyasına, wiki sayfasına veya belgeleme sitesine doğrudan yerleştirilebilen bir Markdown API referans belgesine dönüştürür. Her işlem kendi bölümü olur, böylece yalnızca makineye uygun bir belirtim, takım arkadaşları ve yeni entegratörler için kolaylıkla taranabilir hale gelir.

Çıktı, her grup ve uç noktaya bağlanan bir içindekiler tablosu, yol, sorgu, başlık ve çerez parametreleri için bir parametre tablosu (veya düz bir liste), oluşturulmuş bir istek gövdesi örneği, yanıt kodlarının açıklamalarıyla birlikte bir tablo ve ilk eşleşen şemadan bir örnek yanıt gövdesi içerir. Uç noktaları etikete veya ilk yol segmentine göre gruplandırabilir, istek örneklerinin JSON gövdesi mi yoksa çalıştırmaya hazır curl komutu mu olarak oluşturulacağını seçebilir ve sonucun mevcut bir belgeye yerleştirilmesi için uç nokta başlıklarının ne kadar derin olması gerektiğini belirleyebilirsiniz. Bir açı kullanarak kullanımdan kaldırılan uç noktaları dahil edebilir veya hariç tutabilirsiniz; başka bir açı bileşenlerin altındaki (veya Swagger'ın tanımlarının altındaki) tüm şemaları sonunda kendi bölümü olarak çıkarır.

Aynı dosya içindeki "$ref" işaretçileri parametreler, istek/yanıt gövdeleri ve şemalar için otomatik olarak takip edilir, bu nedenle bileşenlere dayanan bir belirtim ham "$ref" dizelerine sahip olmak yerine tam tablolar ve örnekler üretir. Diğer dosyalara veya URL'lere yapılan referanslar olduğu gibi bırakılır, çünkü bu araçta hiçbir zaman ağ isteği yapılmaz. Oluşturulan Markdown, aracın çıktı sınırını aşarsa, sekme donması yerine açık bir mesaj alırsınız.

Her şey tarayıcınızda yerel olarak çalışır — genellikle ortaya çıkarmak istemediğiniz sistemleri tanımlayan API belirtimleriniz hiçbir zaman hiçbir yere yüklenmez. Markdown'ı kopyalayın, .txt dosyası olarak indirin veya üzerinde çalışmaya devam etmek için başka bir araca gönderin.

FAQ