用途:为 Frappe Framework v15 生成安全、规范的 REST API 端点,覆盖认证、权限检查与输入验证,适用于自定义 API、服务层 HTTP 暴露、公开/私有路由、Webhook 处理及外部系统集成。
主要能力:按 /frappe-api <endpoint_name> [--doctype <doctype>] [--public] 调用,例如 /frappe-api get_dashboard_stats、/frappe-api create_order --doctype "Sales Order"、/frappe-api webhook_handler --public。流程包括收集需求(端点名、HTTP 方法、认证类型、参数、关联 DocType、允许角色)、设计 API 契约(路径 /api/method/<app>.<module>.api.<endpoint_name>、状态码、限流示例)、生成 <app>/<module>/api/<endpoint_name>.py 模块,内含 get、get_list、create、update、delete、submit、cancel、bulk_update_status 等端点及 _check_permission、_validate_request_data 辅助函数,并可选生成 v2 路由与集成测试。
使用方式:端点通过 @frappe.whitelist() 暴露,POST/PUT 成功自动提交、异常回滚;认证可用 Authorization: token api_key:api_secret 或登录后的 Cookie 会话;公开端点使用 allow_guest=True,需谨慎。
限制:资料未提供具体收费、价格、平台支持范围或性能数据;示例中的 <app>、<module>、<DocType>、<Service> 等为占位符,需按实际项目替换;限流 100 req/min 仅为示例,非默认保证。