Dışa Aktarım
Dışa aktarım, Mockomat modelini sana ait dosyalara dönüştürür. İki biçim vardır:
| Biçim | Ne elde edersin | Hangi planlarda |
|---|---|---|
| OpenAPI belirtimi | Tablo başına bir şema içeren bir OpenAPI 3.0.3 YAML dosyası | Hesabı olan her plan |
| Kod paketi | Tabloların için oluşturulmuş bir NestJS backend'i içeren bir ZIP | Professional ve üzeri |
Kod paketleri en az Düzenleyici rolünü ve projede düzenleme erişimini gerektirir. Dışa aktarım projeni asla değiştirmez ve oluşturulan kodun Mockomat'a çalışma zamanı bağımlılığı yoktur.
Biçim ve seçenek adımlarıyla dışa aktarma sihirbazı.
Dışa Aktarımı Başlatma
Uygulamada Export sayfasını aç. Dışa aktarma sihirbazı seni dört adımda yönlendirir:
- Proje — dışa aktarılacak projeyi seç.
- Dışa aktarma biçimi — OpenAPI belirtimi veya kod paketi.
- Dışa aktarmayı yapılandır — kod paketi için bu adım planına dahil olan paketi gösterir.
- Gözden geçir ve dışa aktar — onayla. Bir OpenAPI dosyası hemen indirilir; bir kod paketi arka planda oluşturulur ve hazır olduğunda bir indirme bağlantısıyla görünür.
Uygulaman henüz kod paketi sunmuyorsa, bu arada OpenAPI belirtimini dışa aktar.
Dışa aktarma biçimi seçimi: OpenAPI belirtimi veya kod paketi.
OpenAPI Belirtimi
OpenAPI dışa aktarımı modelini components.schemas olarak yazar: tablo başına bir şema; attribute'lar özellik olarak, zorunlu attribute'lar, enum değerleri ve ilişkilerle birlikte. Yol (paths) içermez. Veri modelini başka araçlarla paylaşmak veya backend ekibinin uygulayacağı bir sözleşmenin başlangıç noktası olarak kullan.
Kod Paketi
Kod paketi, kendin çalıştırabileceğin, değiştirebileceğin ve dağıtabileceğin oluşturulmuş bir projedir.
| Paket | Planlar | İçerik |
|---|---|---|
| Pro | Professional, Business | NestJS arka ucu |
| Enterprise | Enterprise | NestJS arka ucu + Angular ön ucu |
Backend Neleri İçerir
- Code-first GraphQL API'li bir NestJS uygulaması, tablo başına bir modül: entity, resolver, servis ve girdi/çıktı türleri.
- Tablo başına: aramalı sayfalanmış bir liste sorgusu, ID ile bir sorgu ve kayıt oluşturma, güncelleme, silme ve geri yükleme mutasyonları.
- MySQL / MariaDB için TypeORM entity'leri.
- Kimlik doğrulama: JWT ile oturum açma ve bir kullanıcı modülü. İlk başlatmada backend bir yönetici kullanıcısı oluşturur ve şifresini konsola yalnızca bir kez yazdırır.
- MySQL ve Redis'i başlatan bir Docker Compose dosyası ve kurulum adımlarını içeren bir README.
Bugünkü oluşturucunun, kodla plan yapmadan önce bilmen gereken sınırları var:
- MySQL / MariaDB'yi hedefler ve her zaman kimlik doğrulamayı ve Docker Compose dosyasını içerir. Sihirbazdaki veritabanı ve seçenek anahtarları paketi henüz değiştirmez.
- Tabloların arasındaki ilişkiler oluşturulmaz. Bunları oluşturulan entity'lere ve servislere kendin ekle.
- Oluşturulan sütunlar boş değer kabul eder: bir attribute'un Required bayrağı henüz uygulanmaz.
Yerelde Çalıştırma
Paketteki README adımları listeler. Kısaca, backend klasöründe:
npm install
cp .env.example .env # ardından veritabanı kimlik bilgilerini gir
npm run migration:run
npm run start:devBackend bir MySQL veya MariaDB veritabanı ve Redis bekler.
Oluşturulan backend projesinin yapısına genel bakış.
Dışa Aktarmadan Önce
Önce runtime doğrulama kontrol listesini gözden geçir. Temiz bir model daha temiz kod üretir:
- Adlar kurallarına uyar — tablo ve attribute adları sınıf, tür ve alan adlarına dönüşür.
- Attribute türleri doğrudur — sütun ve GraphQL alan türlerine dönüşür.
- Searchable attribute'lar oluşturulan liste sorgusunun arama alanları olur, Sortable attribute'lar ise sıralanabilir liste sütunları olarak işaretlenir.
API Design (İngilizce) bölümünde tasarladığın işlemler ve parametreler mock API'ni şekillendirir; oluşturulan backend ise tablo başına kendi standart sorgu ve mutasyonlarıyla gelir.
Dışa Aktarımdan Sonra Neleri İncelemeli
Modül Sınırları ve Adlandırma
- Her modül modelindeki bir tabloya karşılık geliyor mu?
- Modül, servis ve resolver adları tutarlı ve anlamlı mı?
Girdiler ve Doğrulama
- Oluşturma ve güncelleme girdileri beklediğin alanları içeriyor mu?
- Uygulamanın gerektirdiği alanlar için doğrulama ekle — oluşturulan alanlar isteğe bağlıdır.
İlişkiler
- Modelindeki ilişkileri, tasarladığın yön ve kardinaliteyle oluşturulan entity'lere ekle.
- İlişkili kayıtları servislerde uygulamanın ihtiyaç duyduğu şekilde yükle.
Dışa aktarım sonrası kod inceleme kontrol listesi.
Dışa Aktarım Sonrası Devir Kontrol Listesi
- Modül başına sorumluluk ata — her modülün onu genişletecek bir sorumlusu olmalı.
- Oluşturulanı işaretle — hangi dosyaların oluşturulmuş iskelet, hangilerinin kendi iş mantığına ihtiyaç duyduğunu belirt.
- Bilinen eksikleri kaydet — iş kuralları, harici entegrasyonlar ve arka plan işleri oluşturulmaz.
- Bir başlangıç sürümü commit et — oluşturulan kodu ilk sürüm olarak commit et ve oradan dallan.
- Ortamları yapılandır — veritabanı bağlantıları, ortam değişkenleri ve dağıtım pipeline'ları.
- Erken test et — oluşturulan kod derlenir, ancak davranışı entegrasyon testleriyle erkenden doğrula.
İlk yerel çalıştırma ve doğrulama kontrol listesi.
Kodun Sahipliği
Oluşturulan kod senindir: Mockomat'a çalışma zamanı bağımlılığı yok, çıktı için lisans ücreti yok, ticari kullanım kısıtlaması yok. Onu değiştir, kendi sunucularında veya herhangi bir barındırma sağlayıcısında çalıştır ve müşterilerinle ya da iş ortaklarınla paylaş.