Chuyên viên Đánh giá Hợp đồng API
Dành cho các kỹ sư xem xét các thay đổi API có thể gây lỗi cho khách hàng, hợp đồng hoặc đảm bảo khả năng tương thích ngược.
Best for these models
📋 The Prompt
🔒 Prompt có sẵn trong tải xuống
Nhận toàn bộ nội dung prompt trong file .txt có thể tải xuống. Miễn phí, không cần đăng ký.
Tải PromptVariables to fill in
{{CODE_DIFF}} — Replace with your input {{API_STYLE}} — Replace with your input {{COMPATIBILITY_RULES}} — Replace with your input {{DOWNSTREAM_CLIENTS}} — Replace with your input About this prompt
Chuyên viên Đánh giá Hợp đồng API được thiết kế để xem xét các thay đổi ảnh hưởng đến hình dạng yêu cầu và phản hồi, mã trạng thái, phiên bản và các đảm bảo khả năng tương thích. Nó hoạt động như một nhà thiết kế API cẩn thận, kiểm tra xem PR có gây lỗi cho khách hàng, làm yếu các hợp đồng hoặc giới thiệu hành vi mơ hồ hay không. Điều này đặc biệt hữu ích cho các nhóm hỗ trợ khách hàng bên ngoài, nhiều dịch vụ hoặc các điểm cuối công khai với kỳ vọng về khả năng tương thích nghiêm ngặt.
Prompt này lý tưởng cho các kỹ sư backend, nhóm nền tảng và chủ sở hữu API cần một đánh giá hợp đồng chính xác trước khi hợp nhất. Nó xem xét sự lệch schema, loại bỏ trường, thay đổi hành vi mặc định và khác biệt trong xử lý lỗi. Kết quả giúp người xem quyết định xem một thay đổi có khả năng tương thích ngược, cần phiên bản hoặc cần ghi chú di chuyển. Đặc biệt hữu ích khi nhiều người tiêu dùng phụ thuộc vào cùng một điểm cuối và một thay đổi nhỏ có thể gây ra lỗi lan rộng.
Tuỳ chỉnh với {{CODE_DIFF}}, loại API trong {{API_STYLE}}, và các quy tắc tương thích của bạn trong {{COMPATIBILITY_RULES}}. Nếu điểm cuối có các người tiêu dùng đã biết, thêm họ vào {{DOWNSTREAM_CLIENTS}} để mô hình có thể đánh giá phạm vi ảnh hưởng. Phản hồi bao gồm các rủi ro tương thích, ví dụ phản hồi đề xuất và khuyến nghị phát hành. Sử dụng cùng với phân tích kiểm thử để đảm bảo cả hành vi thực thi và hợp đồng đều được bảo vệ.
Key features
- Kiểm tra tương thích ngược qua các thay đổi yêu cầu và phản hồi.
- Phát hiện sự lệch schema, loại bỏ trường và thay đổi mã trạng thái.
- Hữu ích cho API công khai và hệ sinh thái đa dịch vụ.
- Đề xuất ghi chú di chuyển và các phương án an toàn hơn.
- Hỗ trợ quyết định phát hành cho các điểm cuối hướng tới khách hàng.
Best for
- → Chủ sở hữu API quản lý tích hợp bên ngoài
- → Kỹ sư backend phát hành các thay đổi schema
- → Nhóm nền tảng bảo vệ hợp đồng dịch vụ
Tips
- 💡 Liệt kê các người tiêu dùng phụ thuộc trong {{DOWNSTREAM_CLIENTS}} để cải thiện phân tích phạm vi ảnh hưởng.
- 💡 Thêm chính sách phiên bản của bạn vào {{COMPATIBILITY_RULES}} để có đánh giá nghiêm ngặt hơn.
- 💡 Sử dụng cùng với kiểm thử schema khi các điểm cuối được chia sẻ giữa các nhóm.
What you'll get
Một đánh giá hợp đồng phát hiện các loại bỏ trường gây lỗi, thay đổi hình dạng phản hồi và mã trạng thái giảm sút. Nó có thể đề xuất các phương án an toàn hơn như thêm trường hoặc điểm cuối có phiên bản. Kết quả bao gồm phán đoán về khả năng tương thích và ghi chú di chuyển ngắn gọn để các nhóm có thể truyền đạt các thay đổi tới người tiêu dùng phụ thuộc.
Preparing your download...
Tải PromptPrompts liên quan
API Mock Server Blueprinter
Dành cho các nhóm xây dựng dịch vụ giả lập mô phỏng hành vi API thực tế trước khi hoàn thiện backend.
Forge Tài Liệu Tham Khảo API
Dành cho các nhóm nền tảng tạo tài liệu tham khảo API chính xác từ schemas, routes hoặc ghi chú endpoint.
Kiến Trúc Sư Thiết Bị Kiểm Thử Backend
Dành cho các kỹ sư cao cấp tạo các thiết bị kiểm thử và mô phỏng có thể tái sử dụng cho các bộ kiểm thử backend phức tạp.
Trình Giải Mã Stack Trace Bug Hunter
Dành cho các nhà phát triển cần giải thích nhanh chóng, chính xác về sự cố, ngoại lệ và stack trace trong mã sản xuất.