Nivelle 开拓视野冲破艰险看见世界 身临其境贴近彼此感受生活

接口命名规范

2019-03-14

接口命名设计规范

名词好于动词

第一条RESRful风格设计准则:让本来简单的事情保持简单.

基础URL要保持简单明确,每个资源都应该最多使用两个基础URL来标示

好的基础URL是非常重要的,使得API更简单明确

基础URL不要使用动词

太多的动词会让URL太长,而且没有一致的模式,可读性很差。

使用HTTP协议动词来表达动作

webapi设计1.png

复数名词和具体名词

复数名词好于单数名词

使用复数名词更容易阅读和更直观。但最重要的是,避免使用混合模型,比如对某些资源使用单数,对另外一些资源使用复数。保持一致性允许开发人员在学习使用API​​时猜测方法如何调用。

具体名词要好于抽象名词

评论