Skip to content

自定义动词

实际业务场景中,对资源对象的控制,如升级、上传、移动等操作,用以上规范约束并不能保证 API 语义的唯一性、可理解性、易用性,因此,允许使用自定义动词去显示表达 API 的语义,统一格式为:

/{prefix}/{version}/{resources}:{action}

动词命名请参照自定义动词命名规范

例如,文件导入导出:

/v1/some/resource:import
/v1/some/resource:export

除此之外,撤销操作则使用 cancel 关键字与该动词用英文连字符 - 相连。

例如,停止导入:

/v1/some/resource/name:import-cancel

基于 VitePress 构建