Free Online Developer Tools - ULID, UUID, NanoID, CUID, Snowflake ID, JWT Decoder, Base64, JSON Formatter & More

Menu Công cụ

JSON Patch

Áp dụng JSON Patch theo RFC 6902 trên trình duyệt. Xem add, remove, replace, move, copy và test, gồm cách escape JSON Pointer và việc chỉ số mảng bị dịch.

JSON Patch

Apply RFC 6902 JSON Patch operations to transform JSON documents.

Runs locally
JSON
Ln 1, Col 10 B
Empty
JSON
Ln 1, Col 10 B
Empty
JSON
Ln 1, Col 10 B
Empty

JSON Patch là gì

JSON Patch (RFC 6902) là một danh sách thao tác biến tài liệu JSON này thành tài liệu JSON khác. Mỗi thao tác có op và path. path là JSON Pointer (RFC 6901): đường đi từ gốc, ngăn bởi dấu gạch chéo. Sáu thao tác là add, remove, replace, move, copy và test.

Danh sách có thứ tự. Thao tác sau nhìn thấy tài liệu đã bị thao tác trước sửa. test không sửa tài liệu. Nó kiểm tra một vị trí đang giữ đúng giá trị mong đợi. API dùng việc này để từ chối patch khi người khác đã sửa trường đó.

Trang này áp dụng patch trên trình duyệt của bạn. Tài liệu và patch không được tải lên.

Pointer trỏ tới giá trị thế nào

Pointer rỗng, "", là cả tài liệu. "/name" là thành viên name. "/tags/0" là phần tử đầu của mảng, đếm từ không. "/tags/-" trong thao tác add nghĩa là thêm vào cuối. Dấu "~" trong tên khóa viết thành "~0", dấu "/" trong tên khóa viết thành "~1". Giải "~1" trước "~0", đúng như trang này làm, nên một khóa thật sự chứa chữ "~1" không bị hỏng.

Khóa a/b là /a~1b. Khóa c~d là /c~0d.
{ "op": "add", "path": "/a~1b", "value": 1 }
{ "op": "remove", "path": "/c~0d" }

Một patch làm mẫu

Bắt đầu bằng tài liệu bên dưới. test kiểm tra name vẫn là Ada. replace đổi tên. add với "/tags/-" thêm snowflake, mảng thành ["ulid", "uuid", "snowflake"]. add tạo address.country. remove "/tags/0" rồi mới bỏ ulid, vì chỉ số nói về mảng ở đúng bước đó. Kết quả là khối thứ ba.

Tài liệu
{
  "name": "Ada",
  "tags": ["ulid", "uuid"],
  "address": { "city": "Hanoi" }
}
Patch
[
  { "op": "test", "path": "/name", "value": "Ada" },
  { "op": "replace", "path": "/name", "value": "Ada Lovelace" },
  { "op": "add", "path": "/tags/-", "value": "snowflake" },
  { "op": "add", "path": "/address/country", "value": "VN" },
  { "op": "remove", "path": "/tags/0" }
]
Kết quả
{
  "name": "Ada Lovelace",
  "tags": ["uuid", "snowflake"],
  "address": { "city": "Hanoi", "country": "VN" }
}

move, copy và test

move xóa giá trị tại from rồi thêm vào path. copy thêm mà không xóa, nên nguồn còn nguyên. move một phần tử mảng tới chỉ số phía sau trong cùng mảng rất dễ sai, vì lần xóa làm các phần tử đứng sau dịch lên. test so giá trị hiện tại với value. Nếu không khớp, trang này dừng và báo lỗi, không giả vờ phần còn lại đã được áp dụng. RFC 6902 muốn cả patch thất bại khi một thao tác thất bại. Phía gọi nên coi kết quả là được cả hoặc không có gì.

Khi nào nên dùng

  • Bạn đang viết cập nhật một phần và muốn thấy tài liệu sau một danh sách op thật, không phải sau một lần đối chiếu trong đầu.
  • Bạn cần điều kiện tiên quyết. Đặt test trước để client cũ không ghi đè trường đã đổi.
  • Bạn đang chọn giữa JSON Patch và JSON Merge Patch (RFC 7396). Merge Patch là một tài liệu: object được gộp, mảng bị thay cả khối, null xóa thành viên. Nó không thêm vào cuối mảng và không diễn đạt được test.

Lỗi hay gặp

  • Chỉ số mảng bị dịch. Xóa /tags/0 rồi xóa /tags/1 không xóa phần tử thứ nhất và thứ hai ban đầu. Sau lần xóa đầu, phần tử thứ hai cũ nằm ở chỉ số 0.
  • replace đòi path đã tồn tại. add tạo thành viên object còn thiếu, và add với "-" thêm vào cuối. Dùng replace cho trường mới sẽ thất bại.
  • Path trong RFC 6902 phân biệt hoa thường. Trang này có tùy chọn Ignore Case và mặc định bật. Nó có thể che một khóa sai. Tắt đi khi bạn muốn đúng đặc tả.
  • Strict Path Validation là tùy chọn của trang, không nằm trong RFC. Bật khi bạn muốn một object trung gian còn thiếu là lỗi, thay vì để add tự đi tiếp.
  • Patch không phải định dạng diff để bạn đảo thứ tự. move và remove phụ thuộc các bước trước. Nếu không muốn sửa tay, hãy sinh danh sách từ bản trước và bản sau.

JSON Patch và các định dạng gần đó

Định dạngBạn gửi gìNó không làm được gì
JSON Patch (RFC 6902)Danh sách object op có thứ tựKhông có thay đổi ngầm: mọi thứ là một thao tác
JSON Merge Patch (RFC 7396)Một tài liệu một phầnThêm vào cuối mảng, hoặc test điều kiện. null nghĩa là xóa
Khung xem diff JSONHai tài liệu đầy đủNó chỉ ra chỗ khác. Nó chưa phải thân request trừ khi bạn đổi thành patch

Câu hỏi

/tags/- nghĩa là gì?

Trong thao tác add, ký tự - đứng cuối pointer nghĩa là thêm vào cuối mảng. Đó không phải thành viên tên "-". Với thao tác khác, - không phải chỉ số đặc biệt.

Vì sao remove xóa nhầm phần tử?

Mỗi thao tác nhìn tài liệu do thao tác trước để lại. Sau một lần xóa, chỉ số phía sau trỏ tới phần tử khác. Hãy xóa chỉ số lớn trước, hoặc tạo lại patch từ tài liệu đã cập nhật.

Đặt tên khóa có dấu gạch chéo thế nào?

Phải escape. / trong khóa thành ~1, ~ trong khóa thành ~0. Pointer /a~1b trỏ tới thành viên a/b. /c~0d trỏ tới thành viên c~d.

test có hoàn tác các thao tác trước không?

Trên server làm đúng, test thất bại thì cả patch bị từ chối, kể cả thao tác đứng trước nó. Đừng giả định client được giữ một nửa tài liệu. Đặt test ở đúng chỗ điều kiện phải còn đúng.

Ignore Case có trong RFC 6902 không?

Không. Tên thành viên trong JSON Pointer phải khớp đúng từng ký tự. Ignore Case là công tắc của trang này và mặc định bật. Tắt nó nếu bạn muốn khớp đặc tả.

Nuôi dev bằng ly cà phê để ra nhiều tool xịn hơn nhé