OPENAPI JSON
checkid-dtis-v1.2.260123.json
Theo tài liệu nguồn · đã ẩn danh · chạy ngoại tuyến.
JSON ↓OPENAPI · CHECKID
OpenAPI / Swagger
OpenAPI được tạo từ hợp đồng CheckID API đặc tả V1.2.260123 với ví dụ đã ẩn danh và metadata truy vết nguồn.
OPENAPI YAML
checkid-dtis-v1.2.260123.yaml
Nguồn ánh xạ và công bố trạng thái trong extension nội bộ.
YAML ↓OPENAPI · CHECKID
OpenAPI nguồn có phiên bản, không phải tài liệu suy diễn
CheckID v1.2.260123
Tệp nguồn
Website đóng gói `api/openapi/checkid-dtis-v1.2.260123.yaml` và `.json`. Đây là nguồn đọc được bằng máy để kiểm tra thao tác, lược đồ và quy tắc có điều kiện trước khi viết ví dụ.
Công bố phân loại
Không phải mọi thao tác trong nguồn đều là công khai. Giữ bảng phân loại công khai / đối tác / khách hàng - đối tác và không biến OpenAPI thành lý do để công khai hóa dữ liệu hạn chế.
Độ chuẩn xác của đặc tả
Đường dẫn, header, trường, enum và raw lỗi nguyên bản được giữ đúng nguồn. Phần giải bằng tiếng Việt hoặc tiếng Anh dễ hiểu cho người đọc phải được đặt độc lập bên ngoài khối mã nguyên bản.
Quản lý phiên bản
Mỗi ví dụ phải chỉ ra nguồn phiên bản. Khi OpenAPI thay đổi, khả năng tương thích/errata phải được cập nhật trước khi website đổi đặc tả text.
Bảo mật
Không nhúng thông tin bí mật, private key, access token thật hoặc PII. Giá trị ví dụ dùng placeholder và phải an toàn khi chạy ngoại tuyến.
Vấn đề đã ghi nhận
Signing hồ sơ /còn cần API-owner xác nhận; không dùng OpenAPI trang để che lấp nhập nhằng này.