#ResourceManager Kaynak Yönetimi

NocoBase'in kaynak yönetimi özelliği, mevcut koleksiyonları ve ilişkileri (association) otomatik olarak kaynaklara dönüştürebilir. Bu özellik, geliştiricilerin REST API kaynak işlemlerini hızla oluşturmasına yardımcı olmak için çeşitli yerleşik işlem türleri sunar. Geleneksel REST API'lerinden biraz farklı olarak, NocoBase kaynak işlemleri HTTP istek yöntemlerine doğrudan bağlı değildir; bunun yerine, gerçekleştirilecek belirli işlemi açıkça tanımlanmış :action ile belirlersiniz.

#Otomatik Kaynak Oluşturma

NocoBase, veritabanında tanımlanan koleksiyonları ve ilişkileri otomatik olarak kaynaklara dönüştürür. Örneğin, posts ve tags olmak üzere iki koleksiyon tanımladığınızda:

db.defineCollection({
  name: 'posts',
  fields: [
    { type: 'belongsToMany', name: 'tags' },
  ],
});

db.defineCollection({
  name: 'tags',
  fields: [],
});

Bu durumda aşağıdaki kaynaklar otomatik olarak oluşturulur:

• posts kaynağı
• tags kaynağı
• posts.tags ilişki kaynağı

İstek Örnekleri:

#Kaynak İşlemleri

NocoBase, çeşitli iş ihtiyaçlarını karşılamak için zengin yerleşik işlem türleri sunar.

#Temel CRUD İşlemleri

#İlişki İşlemleri

#İşlem Parametreleri

Yaygın işlem parametreleri şunları içerir:

• filter: Sorgu koşulları
• values: Ayarlanacak değerler
• fields: Döndürülecek alanları belirtir
• appends: İlişkili verileri dahil eder
• except: Alanları hariç tutar
• sort: Sıralama kuralları
• page, pageSize: Sayfalama parametreleri
• paginate: Sayfalamanın etkinleştirilip etkinleştirilmeyeceği
• tree: Ağaç yapısı döndürülüp döndürülmeyeceği
• whitelist, blacklist: Alan beyaz listesi/kara listesi
• updateAssociationValues: İlişki değerlerinin güncellenip güncellenmeyeceği

#Özel Kaynak İşlemleri

NocoBase, mevcut kaynaklar için ek işlemler kaydetmenize olanak tanır. Tüm kaynaklar veya belirli kaynaklar için işlemleri özelleştirmek üzere registerActionHandlers kullanabilirsiniz.

#Genel İşlemleri Kaydetme

resourceManager.registerActionHandlers({
  customAction: async (ctx) => {
    ctx.body = { resource: ctx.action.resourceName };
  },
});

#Belirli Kaynaklara Özgü İşlemleri Kaydetme

resourceManager.registerActionHandlers({
  'posts:publish': async (ctx) => publishPost(ctx),
  'posts.comments:pin': async (ctx) => pinComment(ctx),
});

İstek Örnekleri:

POST /api/posts:customAction
POST /api/posts:publish
POST /api/posts/1/comments:pin

Adlandırma kuralı: resourceName:actionName. İlişkiler dahil edildiğinde nokta sözdizimi (posts.comments) kullanılır.

#Özel Kaynaklar

Koleksiyonlarla ilişkili olmayan kaynaklar sağlamanız gerektiğinde, bunları resourceManager.define yöntemini kullanarak tanımlayabilirsiniz:

resourceManager.define({
  name: 'app',
  actions: {
    getInfo: async (ctx) => {
      ctx.body = { version: 'v1' };
    },
  },
});

İstek yöntemleri, otomatik olarak oluşturulan kaynaklarla tutarlıdır:

• GET /api/app:getInfo
• POST /api/app:getInfo (varsayılan olarak hem GET hem de POST'u destekler)

#Özel Ara Katman Yazılımları (Middleware)

resourceManager.use() yöntemini kullanarak genel ara katman yazılımlarını kaydedebilirsiniz. Örneğin:

Genel günlükleme ara katman yazılımı

resourceManager.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const duration = Date.now() - start;
  console.log(`${ctx.method} ${ctx.path} - ${duration}ms`);
});

#Özel Bağlam (Context) Özellikleri

resourceManager katmanının ara katman yazılımına veya işlemine girebilmek, bu kaynağın mutlaka var olduğu anlamına gelir.

#ctx.action

• ctx.action.actionName: İşlem adı
• ctx.action.resourceName: Bir koleksiyon veya ilişki (association) olabilir
• ctx.action.params: İşlem parametreleri

#ctx.dataSource

Mevcut veri kaynağı nesnesi.

#ctx.getCurrentRepository()

Mevcut repository nesnesi.

#Farklı Veri Kaynaklarının ResourceManager Nesneleri Nasıl Alınır?

resourceManager bir veri kaynağına aittir ve farklı veri kaynakları için ayrı ayrı işlemler kaydedebilirsiniz.

#Ana Veri Kaynağı

Ana veri kaynağı için doğrudan app.resourceManager kullanabilirsiniz:

app.resourceManager.registerActionHandlers();

#Diğer Veri Kaynakları

Diğer veri kaynakları için, dataSourceManager aracılığıyla belirli bir veri kaynağı örneğini alabilir ve bu örneğin resourceManager'ını kullanarak işlem yapabilirsiniz:

const dataSource = dataSourceManager.get('external');
dataSource.resourceManager.registerActionHandlers();

#Tüm Veri Kaynaklarını Yineleme

Eklenen tüm veri kaynakları üzerinde aynı işlemleri gerçekleştirmeniz gerekiyorsa, her veri kaynağının resourceManager'ının ilgili işlemleri kaydedebildiğinden emin olmak için dataSourceManager.afterAddDataSource yöntemini kullanarak yineleme yapabilirsiniz:

dataSourceManager.afterAddDataSource((dataSource) => {
  dataSource.resourceManager.registerActionHandlers();
});