SuperAPI AI 工具集

restful-hateoas

编程与开发

查看项目

更新于 10-16 03:46

技能介绍

用途:为 Ruby on Rails 项目提供 RESTful API 设计规范,帮助接口达到 Richardson 成熟度模型的第 3 级(HATEOAS 超媒体驱动)。适用于设计新端点与资源 URI、为响应添加超媒体控制(_links、affordances)、实现 HAL/JSON:API 等内容协商、构建分页与过滤集合、审查 HTTP 语义与状态码、以及不破坏客户端的 API 演进。

主要能力:内容按请求/响应生命周期组织为 9 类 47 条规则。资源建模(关键)要求 URI 用名词而非动词、集合用复数、嵌套不超过 2 层、用不透明标识符、以子资源表达关系。HTTP 方法语义(关键)涵盖 GET 安全、POST 创建返回 201 与 Location、PUT 全量替换、PATCH 部分更新、DELETE 幂等、HEAD 元数据、幂等键。超媒体与链接关系(关键)要求每个资源含 self 链接、用链接替代外键、以条件链接暴露可用操作、使用 IANA 注册关系类型、提供根入口点、分页链接、嵌入与链接的取舍。此外还包括状态码与响应头、内容协商与厂商媒体类型、集合游标分页与过滤排序字段选择、基于 RFC 9457 的错误语义、ETag 与条件请求缓存、以及仅做增量变更与废弃头部的演进策略。

使用方式:按需阅读各参考文件获取详细说明与代码示例,包括分类定义文件 references/_sections.md 与规则模板 assets/templates/_template.md。

限制:资料未提供具体安装命令、版本要求或收费信息,暂未提供。