Thiết kế hợp đồng API cho dự án
api-architect
Thiết kế giao diện trao đổi dữ liệu (API) kiểu REST hoặc GraphQL, xuất đặc tả OpenAPI, nêu cách xác thực, đánh phiên bản, phân trang và định dạng lỗi, không gắn với công nghệ nào.
Tải miễn phí. Theo dõi Skilnexa một lần là mở khoá mọi lượt tải trên web.
Nó là gì
Dành cho đội phát triển cần thiết kế hợp đồng API mới hoặc sửa API cũ, dù dùng REST hay GraphQL. Agent này viết đặc tả OpenAPI hoặc GraphQL, nêu cách xác thực, phân trang, phiên bản và định dạng lỗi, không gắn với công nghệ backend cụ thể.
Hoạt động ra sao
AI đọc các mô hình dữ liệu và luồng nghiệp vụ có sẵn, chọn REST hay GraphQL, rồi định nghĩa tài nguyên, phiên bản, xác thực và định dạng lỗi chuẩn. Nó kiểm tra đặc tả bằng công cụ lint và viết tài liệu có ví dụ. Trả ra file openapi.yaml hoặc schema.graphql và báo cáo thiết kế nêu các câu hỏi còn mở.
Ví dụ ứng dụng
- Tình huống
- Công ty có app đặt phòng khách sạn và đối tác muốn lấy dữ liệu phòng trống qua API.
- Bạn đưa vào
- Các đối tượng chính như phòng, đặt phòng, khách và cách xác thực đối tác.
- Bạn nhận được
- File openapi.yaml mô tả các endpoint, quy ước phân trang và ví dụ request, response cho đối tác.
Ví dụ minh họa theo quy trình trong tài liệu gốc, chưa phải kết quả thử chạy.
Dùng khi nào
Khi sắp bắt đầu dự án và cần thống nhất API giữa nhóm giao diện và nhóm máy chủ.
Các phần chính trong hướng dẫn
- Quy trình vận hành
- Mẫu kết quả đầu ra
- Nguyên tắc thiết kế nhanh
Xem mô tả gốc của tác giả (tiếng Anh)
Universal API designer specializing in RESTful design, GraphQL schemas, and modern contract standards. **MUST BE USED** proactively whenever a project needs a new or revised API contract. Produces clear resource models, OpenAPI/GraphQL specs, and guidance on auth, versioning, pagination, and error formats—without prescribing any specific backend technology.
Cùng nhóm Kỹ thuật phần mềm
- Chuyên gia viết web bằng Actix (ngôn ngữ Rust)Hỗ trợ viết ứng dụng web hiệu năng cao bằng Actix trên ngôn ngữ Rust: máy chủ HTTP, lập trình bất đồng bộ, mô hình actor và các lớp xử lý trung gian.
- Tìm và cài đặt agent Claude Code từ kho mẫuLiệt kê nhóm agent, tìm theo tên hoặc mô tả và cài agent từ kho awesome-claude-code-subagents trên GitHub vào máy bạn.
- Chuyên gia lập trình ứng dụng AndroidHỗ trợ viết ứng dụng Android hiện đại bằng Kotlin hoặc Java, dùng thư viện Jetpack, tối ưu tốc độ và bộ nhớ, giữ cấu trúc ứng dụng vững.
- Kiến trúc ứng dụng Angular quy mô lớnThiết kế ứng dụng Angular 15+ cho doanh nghiệp: quản lý trạng thái phức tạp, tối ưu RxJS, chia micro-frontend (giao diện ghép từ nhiều phần độc lập), xử lý hiệu năng.
- Viết mã Angular đúng chuẩn và nhanhViết mã Angular theo thực hành tốt: chia component, dùng RxJS, quản lý trạng thái bằng NgRx hoặc Akita, dùng Angular CLI, tối ưu hiệu năng.
- Chuyên gia AngularJS bản cũHỗ trợ tối ưu mã AngularJS (phiên bản đời đầu): tổ chức cấu trúc, tăng tốc vòng cập nhật scope, liên kết dữ liệu hai chiều, viết directive và component riêng.
Phần giải thích do Skilnexa viết sau khi đọc toàn bộ tài liệu gốc của tác giả và đã đối chiếu lại với nội dung gốc. Chưa phải kết quả thử chạy, nên hãy thử bằng dữ liệu giả trước khi dùng cho việc thật.