API tasarımcısı

API tasarımcısı, tam bir API’yi doğrudan Restorm içinde tasarlamanıza olanak tanır: verilerinizi ve rotalarınızı tanımlarsınız, gerisini Restorm halleder — tasarımınızı gerçek bir mock sunucu gibi sunar ve şablonlardan yola çıkarak uygulamanızın kodunu üretir.

Back-end henüz yokken bir API’ye başlamak için ideal araçtır: sözleşmeyi taslak olarak oluşturun, müşterilerinize test ettirin ve her şeyi projenizde sürümlenmiş halde tutun.

Bir tasarım, birden çok bölüm

Bir tasarım, herhangi bir öğe gibi oluşturulur: bir klasöre sağ tıklayın ▸ Ekle ▸ API Tasarımı. Kendi sekmesinde açılır ve kenar çubuğundan erişilebilen birden çok bölümü bir araya getirir:

Bölüm	Ne işe yarar
Modeller	Varlıklarınız ve özellikleri — bkz. Modeller, enum’lar ve özellikler.
Enum’lar	Özellik tipi olarak yeniden kullanılabilen kapalı değer kümeleri.
Rotalar	Kaynağa göre gruplanmış API giriş noktaları — bkz. Rotalar & CRUD.
Sunucu	Tasarımı bir mock olarak HTTP, GraphQL, SOAP, OData veya gRPC üzerinden sunar — bkz. Tasarımı mock olarak sunma.
İstemciler	Çalışan mock’u çağıran, kullanıma hazır istekler — bkz. İstemciler.
Dokümantasyon & Notlar	Tasarıma iliştirilmiş dokümantasyon ve serbest notlar.
Kod	Şablonlarınızdan kod üretimi — bkz. Kod üretimi.

Tasarımın ayarları (ad, varsayılan değerler), kenar çubuğundaki tasarım düğümüne doğrudan tıklanarak açılır.

Tipik akış

1. Verilerinizi tanımlayın — modellerinizi ve enum’larınızı oluşturun, özelliklerini, tiplerini ve kısıtlarını ekleyin.
2. Rotalarınızı belirleyin — elle ya da bir modelden tek tıkla CRUD üret ile.
3. Mock’u sunun — sunucuyu başlatın ve uygulamanızı veya bir istemciyi ona yöneltin. Aynı tasarım, etkinleştirilen her protokole otomatik olarak yansıtılır.
4. Kodu üretin — bir veya birden çok şablon seçin (kendiniz ya da Restorm’un önerdikleri) ve karşılık gelen projeyi oluşturun.

Her adım, bu bölümün sayfalarında ayrıntılı olarak açıklanmıştır.