#ResourceManager Manajemen Resource

Fitur manajemen resource NocoBase secara otomatis mengkonversi tabel data (Collection) dan asosiasi (Association) menjadi resource, dan menyediakan beberapa tipe operasi bawaan, sehingga Anda dapat dengan cepat membangun REST API. Sedikit berbeda dengan REST API tradisional, operasi resource NocoBase tidak langsung bergantung pada method HTTP request, tetapi menentukan operasi spesifik yang dieksekusi melalui definisi :action secara eksplisit.

#Resource yang Dihasilkan Otomatis

NocoBase secara otomatis akan mengkonversi Collection dan Association yang didefinisikan dalam database menjadi resource. Misalnya mendefinisikan dua collection posts dan tags:

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

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

Sistem akan secara otomatis menghasilkan resource berikut:

• Resource posts
• Resource tags
• Resource asosiasi posts.tags

Contoh request:

#Operasi Resource

NocoBase memiliki beberapa tipe operasi bawaan, yang mencakup skenario bisnis umum.

#Operasi CRUD Dasar

#Operasi Relasi

#Parameter Operasi

Parameter operasi umum termasuk:

• filter: Kondisi query
• values: Nilai yang diatur
• fields: Menentukan field yang dikembalikan
• appends: Menyertakan data terkait
• except: Mengecualikan field
• sort: Aturan sorting
• page, pageSize: Parameter pagination
• paginate: Apakah mengaktifkan pagination
• tree: Apakah mengembalikan struktur tree
• whitelist, blacklist: Whitelist/blacklist field
• updateAssociationValues: Apakah memperbarui nilai asosiasi

#Operasi Resource Kustom

Anda dapat menggunakan registerActionHandlers untuk mendaftarkan operasi tambahan untuk resource yang ada, mendukung operasi global dan operasi resource khusus.

#Mendaftarkan Operasi Global

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

#Mendaftarkan Operasi Khusus Resource

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

Contoh request:

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

Aturan penamaan: resourceName:actionName, saat menyertakan asosiasi gunakan sintaks dot (posts.comments).

#Resource Kustom

Jika Anda perlu menyediakan resource yang tidak terkait dengan tabel data, dapat menggunakan resourceManager.define untuk mendefinisikan:

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

Method request sama dengan resource otomatis:

• GET /api/app:getInfo
• POST /api/app:getInfo (default mendukung GET/POST sekaligus)

#Middleware Kustom

Menggunakan resourceManager.use() dapat mendaftarkan middleware global. Misalnya middleware logging global:

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

#Property Khusus Context

Dapat memasuki middleware atau action di layer resourceManager, berarti resource tersebut pasti ada. Pada saat ini Anda dapat mengakses konteks request melalui property berikut:

#ctx.action

• ctx.action.actionName: Nama operasi
• ctx.action.resourceName: Mungkin berupa collection atau association
• ctx.action.params: Parameter operasi

#ctx.dataSource

Objek data source saat ini

#ctx.getCurrentRepository()

Objek repository saat ini

#Cara Mendapatkan Objek resourceManager dari Data Source yang Berbeda

resourceManager milik data source, Anda dapat mendaftarkan operasi secara terpisah untuk data source yang berbeda.

#Data Source Utama

Data source utama dapat langsung menggunakan app.resourceManager:

app.resourceManager.registerActionHandlers();

#Data Source Lain

Data source lain dapat memperoleh instance yang sesuai melalui dataSourceManager:

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

#Iterasi Semua Data Source

Jika perlu mengeksekusi operasi yang sama untuk semua data source, dapat menggunakan dataSourceManager.afterAddDataSource untuk iterasi:

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

#Tautan Terkait

• Cheatsheet Resource API — Method signature lengkap dan penggunaan MultiRecordResource / SingleRecordResource client
• ACL Kontrol Hak Akses — Mengkonfigurasi hak akses role dan kontrol akses untuk operasi resource
• Context Konteks Request — Mendapatkan informasi konteks dalam handler request
• Middleware — Menambahkan logika intersepsi dan pemrosesan untuk request
• DataSourceManager Manajemen Data Source — Mengelola beberapa data source dan resource manager-nya
• Collections Tabel Data — Hubungan mapping otomatis Collection dengan Resource