Tổng quan Backend DINHDANH cho kho JSON danh sách indexed
Kho JSON Backend

DINHDANH Creator · Bài AM02 · API REFERENCE §1 · Chi tiết từng method

Sổ nhiều dòng (indexed)
4 method - cấu trúc đầy đủ

Dùng cho blog, liên hệ, sản phẩm, đơn hàng. Không dùng writeFile để ghi từng dòng danh sách.

Mục tiêu: Nắm chính xác tham số + kết quả từng hàm; làm form / list / sửa / xóa đúng.

Trước: AM01 · Sau: AM03 · Nhớ: danh sách luôn ở data.content (không phải items).

Sơ đồ nhanh

Thêm dòng → appendData → nhận data.id
Xem danh sách → readList → data.content[]
Xem 1 dòng đủ → readFile(file, id) → data.content object
Sửa / xóa (đã login) → updateData (object hoặc null)

Method 1 / 4

appifio_readList(fileName, fields?)

Việc làm: Đọc danh sách nhiều dòng - nhẹ hơn đọc cả file.

Ai được gọi: Public (khách cũng được). Lưu ý: cài đặt bảo mật CMS có thể ẩn bớt dòng/field với khách.

Tham số:

  • fileName - tên sổ, vd. blog.json, contacts.json
  • fields (tuỳ chọn) - mảng tên cột cần lấy, vd. ['id','title','slug']. Bỏ trống / [] = lấy mọi field.

Cách gọi:

const res = await appifio_client.appifio_readList(
  'blog.json',
  ['id', 'title', 'slug', 'created_at']
);

Kết quả trả về:

{ success, data: { content: [ { id, ...fields }, ... ] } }
  • content luôn là mảng. Chưa có dữ liệu → [] (không phải lỗi 404).
  • Sai phổ biến: đọc data.items → luôn trống. Đúng: data.content.

Method 2 / 4

appifio_readFile(fileName, id?) - có id (1 dòng)

Việc làm: Đọc một bản ghi đầy đủ trong sổ (trang chi tiết).

Ai được gọi: Public

Tham số:

  • fileName - cùng sổ với list
  • id - mã dòng (lấy từ readList hoặc sau appendData). Có id = 1 item. Không id = kiểu flat / master (xem AM03).

Cách gọi:

const res = await appifio_client.appifio_readFile('blog.json', '1778237139260');
const post = res.data?.content; // object hoặc null

Kết quả trả về:

{ success, data: { content: object | null } }
// JSON đã được parse sẵn - KHÔNG cần JSON.parse thêm
  • Không tìm thấy id / bị lọc → content: null.
  • Luồng hay dùng: list lấy id → detail gọi readFile(file, id).

Method 3 / 4

appifio_appendData(fileName, content)

Việc làm: Thêm một dòng mới vào sổ (form liên hệ, đăng bài…).

Ai được gọi: Public (mặc định). CMS có thể siết: chỉ admin mới thêm được một số loại nội dung.

Tham số:

  • fileName - tên sổ
  • content - một object (không được null, không chuỗi rỗng, không mảng).

Cách gọi:

const res = await appifio_client.appifio_appendData('contacts.json', {
  name: 'Lan',
  email: 'lan@mail.com',
  message: 'Xin báo giá'
});
const newId = res.data.id;

Kết quả trả về:

{ success: true, data: { id: "1778237139260" } }
  • Máy chủ tự gán id, created_at, IP tạo - bạn không cần tự tạo id.
  • Lần append đầu tiên: nếu sổ chưa có, hệ thống tự tạo - không bắt buộc admin tạo trước.
  • Gửi quá nhiều lần → có thể bị tạm dừng (“Thử lại sau”).

Method 4 / 4

appifio_updateData(fileName, id, content)

Việc làm: Sửa một dòng (gộp field) hoặc xóa dòng (content = null).

Ai được gọi: Admin+ (đã đăng nhập: user / admin / siêu quản trị)

Tham số:

  • fileName, id - sổ và mã dòng
  • content - object → chỉ ghi đè các field có trong object (merge). null → xóa item khỏi sổ.

Cách gọi:

// Sửa
await appifio_client.appifio_updateData('blog.json', id, { title: 'Tiêu đề mới' });

// Xóa 1 dòng (KHÔNG dùng deleteFile cả blog.json)
await appifio_client.appifio_updateData('blog.json', id, null);

Kết quả trả về:

{ success: true, message: "Success" }
  • Role user: không được xóa bằng null; không được đặt một số trạng thái “thùng rác”.
  • Id không tồn tại → lỗi kiểu “Item not found”.

Ví dụ ghép - form + list

Panel nội dung database Backend với giới hạn hàng và API
Panel nội dung database
await appifio_client.appifio_appendData('contacts.json', { name, email, message });

const list = await appifio_client.appifio_readList('contacts.json', ['id','name','email','created_at']);
const rows = list.data?.content || [];

const one = await appifio_client.appifio_readFile('contacts.json', rows[0].id);
// one.data.content = object chi tiết

Checklist

  1. List → content; detail → readFile(file, id)?
  2. Xóa dòng = updateData(..., null), không deleteFile cả sổ?

AM03 - Flat & lifecycle (đủ mọi method §2)

DINHDANH Creator · Loạt Method · AM02 · 4/4 method §1