API Blueprint belgesini içe aktarma
API Blueprint, bir API’yi zenginleştirilmiş Markdown ile betimler. Restorm onu, WebAssembly’ye derlenip gömülmüş olan resmî ayrıştırıcıyla (Drafter) işler: hiçbir dış araç gerekmez.
İçe aktarma
Section titled “İçe aktarma”Dosya ▸ İçe aktar (Ctrl+I), ardından .apib dosyası ya da FORMAT: 1A
ile başlayan yapıştırılmış içerik.
İçe aktarılanlar
Section titled “İçe aktarılanlar”| Öğe | Restorm’un yaptığı |
|---|---|
| Kaynak grupları | Klasörler |
| Her geçiş | Bir HTTP isteği |
| Parametreler | Türlenmiş olarak |
| Sunucunun URL’si | Ortamın temel URL’si |
| Açıklamalar ve modeller | API dokümantasyonu |
Bir geçiş için birden çok örnek
Section titled “Bir geçiş için birden çok örnek”Bir API Blueprint geçişi birden çok + Request / + Response çifti
bildirebilir. Restorm her çift için bir istek oluşturur ve bunları ayırt
etmek üzere bir indeks soneki (#1, #2…) ekler.