术语

REST APIs中重要的术语

Resource代表包含一些关联数据和一系列操作对象的actions,例如animals,schools,employees是resource,而delete,add,update是操作这些对象的actions

Collections是resource的集合(复数形式)

URL是能够定位到resource或对resource的操作的路径

API Endpoints

API Endpoints指处理resource和collections的一系列URL,URL应该指包括resource(名词),而不包含动作(动词),例如应该使用/users而不是/addUsers,用HTTP methods(GET/POST/PUT/DELETE)来定义actions

HTTP Methods

重要的HTTP methods包括:

Untitled

RESTful的标准不允许路径中出现action,但实际使用时也有例外,例如对某个resource指定action

Untitled

API版本

避免API升级带来的影响,要求所有API都要有版本的概念(必须以/api/{VERSION}开头,version的格式为:

Alpha