Apidog'da Bir Alan İçin Numaralandırma (Enum) Nasıl Ayarlanır?

Merhaba! Apidog ile API tasarımına dalıyorsanız ve arayüzlerinizi son derece net hale getirmek istiyorsanız, numaralandırmaları (veya enum'ları) kurmak bir zorunluluktur. Enum'lar, bir alan için sabit bir değer kümesi tanımlamanıza olanak tanır – örneğin bir kullanıcı durumu için “aktif,” “dondurulmuş” veya “silinmiş” gibi – geliştiricilerin yalnızca bu seçenekler arasından seçim yapmasını sağlar. Bu, can sıkıcı hataları önler ve API dokümantasyonunuzu keskin tutar. Bu sohbet tarzı kılavuzda, Apidog'da dizeler, diziler ve daha fazlası için numaralandırmaları nasıl ayarlayacağımızı, sezgisel kullanıcı arayüzünü ve yapay zeka destekli özelliklerini kullanarak keşfedeceğiz. İster yeni başlayan ister deneyimli bir geliştirici olun, Apidog numaralandırmalarını kısa sürede bir profesyonel gibi ayarlayabileceksiniz. Hadi başlayalım!

Apidog'da Neden Numaralandırmalar Kullanmalıyız?

Numaralandırmalar, API alanlarınız için birer koruyucu bariyer gibidir. Yalnızca “aktif,” “dondurulmuş” veya “silinmiş” değerlerinin geçerli olduğu bir “kullanıcı durumu” alanı hayal edin. Bir enum olmadan, geliştiriciler yanlışlıkla “pasif” veya “yasaklı” gibi değerler geçirebilir ve bu da API'nizin tıkanmasına neden olabilir. **Apidog numaralandırmalarını** ayarlayarak, izin verilen değerleri açıkça listeler, dokümantasyonunuzu netleştirir ve hataları azaltırsınız. Ayrıca, Apidog'un Mock veri özelliği bu enum'lara otomatik olarak uyar ve kurallarınıza uygun test verileri üretir. İster “beklemede” gibi bir dize, ister belirli izinlerin bir dizisi olsun, enum'lar işbirliğini kolaylaştırır ve API'nizi sağlam tutar.

API tasarımı, hata ayıklama ve test için güçlü bir platform olan Apidog, dizeler, tam sayılar, sayılar ve diziler dahil olmak üzere çeşitli veri türleri için enum'ları destekler. Ekstra netlik için her değere açıklamalar bile ekleyebilirsiniz. Temel dizelerden karmaşık dizilere kadar bunları nasıl kuracağımıza dalalım ve yapay zeka ile yeniden kullanılabilir modellerin hayatınızı nasıl kolaylaştırabileceğini keşfedelim.

Apidog'da Temel Numaralandırmaları Kurma

En basit durumla başlayalım: bir kullanıcı durumu veya sipariş durumu gibi bir dize veya sayı alanı için bir numaralandırma ayarlamak. İşte nasıl yapılacağı:

1. Arayüz Düzenleyiciyi Açın:

• Apidog'da projenize gidin ve üzerinde çalıştığınız arayüzü (uç noktayı) açın. İstek veya yanıt gövdesindeki user_status gibi kısıtlamak istediğiniz alanı bulun.

2. Veri Tipini Seçin:

• Alan ayarlarında, açılır menüden veri tipini seçin – genellikle string (örn. “aktif” için), integer veya number. Örneğin, user_status için string seçin.

3. Gelişmiş Ayarlara Erişin:

• Alan tipinin yanındaki Gelişmiş Ayarlar düğmesine tıklayın. Bu, enum'u yapılandırabileceğiniz bir panel açar.

4. Numaralandırma Değerlerini Ekle:

• Numaralandırma Değerleri bölümünde, izin verilen değerlerinizi her satıra bir tane gelecek şekilde girin. user_status için şunları ekleyebilirsiniz:
• active (Açıklama: “Kullanıcı aktif ve giriş yapabilir”)
• frozen (Açıklama: “Kullanıcı hesabı geçici olarak askıya alındı”)
• deleted (Açıklama: “Kullanıcı hesabı kalıcı olarak silindi”)
• İsteğe bağlı olarak, dokümantasyonu daha net hale getirmek için her değere açıklamalar ekleyin.

5. Kaydet ve Dokümantasyonu Kontrol Et:

• Değişikliklerinizi kaydedin. API dokümantasyonunda, Apidog bu değerleri alan için tek geçerli seçenekler olarak gösterecektir. Ekip üyeleri şuna benzer bir şey görecektir: “user_status: [aktif, dondurulmuş, silinmiş] değerlerinden biri olmalıdır.”

Apidog'da hata ayıklarken, test isteklerinizin geçerli olduğundan emin olmak için bu enum değerlerini doğrudan bir açılır menüden seçebilirsiniz. Herkesi aynı sayfada tutmanın basit bir yoludur!

Profesyonel İpucu: Enum panelindeki Toplu Düzenleme özelliğini kullanarak birden fazla değeri aynı anda yapıştırabilir, uzun listeler için zamandan tasarruf edebilirsiniz.

Apidog'da Dizi Numaralandırmalarını Yönetme

Dizi numaralandırmaları biraz daha karmaşıktır ancak kullanıcı izinleri veya koordinatlar gibi alanlar için süper kullanışlıdır. Apidog iki tür dizi enum'unu destekler: bireysel dizi elemanlarını kısıtlamak veya tüm diziyi belirli kombinasyonlarla sınırlamak. Hadi bunu inceleyelim.

Senaryo 1: Dizi Elemanı Değerlerini Kısıtlama

Diyelim ki, her bir dizenin “oku,” “yaz” veya “sil” değerlerinden biri olması gereken bir dizeler dizisi olan bir permissions alanınız var. Geçerli diziler ["read"], ["write", "delete"] veya ["read", "write", "delete"] olabilir. İşte nasıl kurulacağı:

1. Alanı Dizi Tipine Ayarla:

• Arayüz düzenleyicide, alanı (örn. permissions) array tipine ayarlayın.

2. Alt Eleman Tipini Yapılandır:

• Dizi ayarlarının altında, bir Alt Eleman Tipi seçeneği göreceksiniz. string (veya integer gibi başka bir tip) seçin.

3. Enum Değerlerini Ekle:

• Alt eleman için Gelişmiş Ayarlar'a tıklayın. Numaralandırma Değerleri bölümüne şunları ekleyin:
• read (Açıklama: “Salt okunur erişim”)
• write (Açıklama: “Yazma erişimi”)
• delete (Açıklama: “Silme erişimi”)

4. İsteğe Bağlı: Tekliği Zorla:

• Dizinin gelişmiş ayarlarında, kopyaları önlemek için Tüm Elemanlar Benzersiz Olmalı seçeneğini etkinleştirin (örn. ["read", "read"] geçersiz hale gelir).

5. Kaydet ve Test Et:

• Kaydedin, ve dokümantasyon dizinin elemanlarının bu değerlerle kısıtlandığını gösterecektir. Mock veriler, enum ve teklik kurallarına uyarak ["read", "write"] gibi diziler üretecektir.

Alternatif olarak, Gelişmiş Ayarlar sekmesinde JSON Şemasını manuel olarak düzenleyebilirsiniz:

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": ["read", "write", "delete"]
  },
  "uniqueItems": true
}

Bu, dizideki her elemanın enum'a uymasını sağlar.

Senaryo 2: Tüm Dizi Değerlerini Kısıtlama

Bazen, tüm dizinin birkaç sabit kombinasyondan biri olmasını istersiniz, örneğin yalnızca [0, 0] veya [100, 100] olabilen bir coordinate alanı. İşte nasıl yapılacağı:

1. Alanı Dizi Tipine Ayarla:

• Alan için (`coordinate` gibi) array seçin.

2. JSON Şemasını Düzenle:

• Gelişmiş Ayarlar'da, JSON Şeması düzenleyicisine geçin ve şunu girin:

{
  "type": "array",
  "enum": [
    [0, 0],
    [100, 100]
  ]
}

• Bu, alanı tam olarak bu dizilerle kısıtlar – [0, 100] gibi başka kombinasyonlara izin verilmez.

3. Kaydet ve Doğrula:

• Kaydedin, ve dokümantasyon [0, 0] ve [100, 100] değerlerini tek geçerli değerler olarak listeleyecektir. Mock veriler bu dizilerden birini rastgele seçecektir.

Bu yaklaşım daha az yaygındır ancak önceden tanımlanmış ayarlar veya sabit veri yapıları gibi belirli kullanım durumları için güçlüdür.

Numaralandırma Kurulumunu Basitleştirmek İçin Yapay Zeka Kullanımı

Karmaşık enum'lar, özellikle diziler için JSON Şeması yazmak, sözdizimiyle boğuşmak gibi gelebilir. Neyse ki, **Apidog**’un yapay zeka özelliği günü kurtarmak için burada! Enum gereksinimlerinizi sade bir dille açıklamanıza olanak tanır ve doğru yapılandırmayı üretir.

1. Apidog'da Yapay Zekayı Etkinleştir:

• Ekip Ayarları > Yapay Zeka Özellikleri'ne gidin ve yapay zeka desteğini etkinleştirin. Ayrıntılar için Apidog'un yardım belgelerine bakın.

2. İhtiyaçlarınızı Açıklayın:

• Arayüz düzenleyicide, yapay zeka sohbet panelini açın ve şuna benzer bir şey yazın:

coordinate[1, 2][3, 4]

• Veya bir dize için: “status alanını beklemede, ödendi veya tamamlandı ile kısıtla.”

3. Önizle ve Uygula:

• Yapay zeka, aşağıdaki gibi JSON Şemasını üretir:

{
  "type": "array",
  "enum": [
    [1, 2],
    [3, 4]
  ]
}

• Çıktıyı inceleyin, ardından alanınıza eklemek için Uygula'ya tıklayın.

4. Test Edin:

• Enum'un doğru olduğundan emin olmak için dokümantasyonu kontrol edin. Apidog'un arayüzünde enum değerleriyle hata ayıklamayı deneyin.

Yapay zeka, karmaşık şemalar veya JSON sözdizimi konusunda emin olmadığınız durumlarda hayat kurtarıcıdır. Google'da aramaktan daha hızlıdır ve doğruluk sağlar.

Mock Veri ve Numaralandırmalar

Apidog’un en havalı özelliklerinden biri, enum'ları Mock veriyle nasıl entegre ettiğidir. Bir enum ayarladığınızda, Apidog’un Mock hizmeti, kısıtlamalarınıza uyan test verilerini otomatik olarak üretir. Örneğin:

• Dize Enum: Eğer status ["active", "frozen", "deleted"] ile kısıtlanmışsa, Mock veri bu değerlerden birini rastgele seçecektir.
• Benzersiz Elemanlara Sahip Dizi Enum: ["read", "write", "delete"] ve teklik etkinleştirilmiş bir permissions dizisi için, ["read", "write"] alabilirsiniz ama asla ["read", "read"] alamazsınız.
• Sabit Dizi Enum: [[0, 0], [100, 100]] olan bir coordinate alanı, yalnızca bu tam dizilerden birini döndürecektir.

Bu, test verilerinizin API spesifikasyonlarınızla uyumlu olmasını sağlar, hata ayıklama ve işbirliğini daha sorunsuz hale getirir. Mock veriyi etkinleştirmek için, arayüz düzenleyicideki Mock seçeneğini açıp kapatın ve sonuçları önizleyin.

Yeniden Kullanılabilir Numaralandırma Modelleri Tanımlama

Eğer aynı enum, kullanıcı oluşturma, güncelleme ve listeleme API'lerindeki user_status gibi birden fazla uç noktada görünüyorsa, her seferinde yeniden tanımlamak zahmetlidir. **Apidog**, tutarlılığı sağlamak için yeniden kullanılabilir veri modelleri oluşturmanıza olanak tanır.

1. Bir Veri Modeli Oluşturun:

• Apidog projenizde Veri Modelleri'ne gidin.
• Yeni Model'e tıklayın, adlandırın (örn. UserStatusEnum) ve kök düğümü string olarak ayarlayın.
• Gelişmiş Ayarlar'da, active, frozen, deleted gibi enum değerlerini isteğe bağlı açıklamalarla ekleyin.

2. Modeli Referans Alın:

• Herhangi bir arayüzde, alanın tipini Referans olarak ayarlayın ve UserStatusEnum'u seçin.

3. Bir Kez Güncelle, Her Yere Senkronize Et:

• Yeni bir durum (örn. suspended) eklemeniz gerekirse, UserStatusEnum modelini güncelleyin ve tüm referans veren uç noktalar otomatik olarak güncellenir.

Bu yaklaşım zamandan tasarruf sağlar ve projeniz genelinde tutarlılık sağlar. Birden fazla geliştiricinin aynı enum'lara güvendiği ekipler için mükemmeldir.

Yaygın Numaralandırma Sorunlarını Giderme

• Enum Belgelerde Görünmüyor mu? Arayüzü kaydedin ve dokümantasyon sayfasını yenileyin. Gerekirse alanın Gerekli olarak işaretlendiğinden emin olun.
• Mock Veri Enum'ları Yoksayıyor mu? Enum değerlerinin Gelişmiş Ayarlar veya JSON Şemasında doğru ayarlandığından emin olun. Mock seçeneğini kapatıp açın.
• Dizi Enum Hataları mı? Eleman düzeyindeki enum'lar için, alt eleman tipinin doğru ayarlandığından emin olun. Sabit diziler için, JSON Şeması sözdizimini doğrulayın.
• Yapay Zeka Şema Oluşturmuyor mu? İsteminizi netleştirin (örn. “Tam dizilerle kısıtla”) ve yapay zekanın Ekip Ayarları'nda etkinleştirildiğinden emin olun.

Numaralandırmalar Neden Apidog'u Parlatıyor?

**Apidog numaralandırmaları**, API tasarımı için ezber bozan bir özelliktir. Alan kısıtlamalarını netleştirir, hataları azaltır ve dokümantasyon okunabilirliğini artırır. Yapay zeka özelliği karmaşık kurulumları basitleştirirken, yeniden kullanılabilir modeller tutarlılık sağlar. Mock veri entegrasyonu, testlerinizin her zaman spesifikasyonlara uygun olduğu anlamına gelir. Postman gibi araçlarla karşılaştırıldığında, Apidog'un görsel düzenleyicisi ve yapay zekası, özellikle diziler için enum kurulumunu daha sezgisel hale getirir. Kullanıcılar Apidog'u “API belgelerini hatasız hale getirdiği” için övüyor ve enum desteğiyle bunun nedenini görmek kolay.

Sonuç

**Apidog numaralandırmalarını** ayarlamak, ister dizeleri, ister sayıları, ister dizileri kısıtlıyor olun, çok kolaydır. Görsel düzenleyiciden yapay zeka destekli JSON Şeması oluşturmaya kadar, Apidog API'lerinizi sağlam ve geliştirici dostu hale getirir. Yeniden kullanılabilir bir enum modeli oluşturmayı veya işleri hızlandırmak için yapay zekayı kullanmayı deneyin ve ipuçlarınızı yorumlarda paylaşın. API tasarımını birlikte daha sorunsuz hale getirelim!