Restful风格接口定义
发布时间:2020-12-14 04:37:54 所属栏目:大数据 来源:网络整理
导读:一个HTTP接口的结构通常为 协议 :// 域名 / 应用content path / 自定义路径 ? 查询参数 以下给出一些定义接口的建议 一、域名相关 若域名无法区分出是api还是页面功能的时候,api路径后面统一加上 /api 用于区分是接口服务。 例如 http://bos3d.bimwinner.c
一个HTTP接口的结构通常为 协议://域名/应用content path/自定义路径?查询参数 以下给出一些定义接口的建议 一、域名相关 若域名无法区分出是api还是页面功能的时候,api路径后面统一加上/api用于区分是接口服务。 例如 http://bos3d.bimwinner.com/api/test/files 为向test数据库上传文件。 二、词性相关 使用名词的复数形式定义资源,动词词性使用下划线区分。 GET/users/{userId} //查看某个具体用户的信息 POST/users //新建一个用户 PUT/users/{userId} //全量更新一个用户的信息 GET/users/_serch //搜索用户 POST/users/_init //初始化所有用户 备注:批量操作时统一使用POST作为http method;URL对大小写敏感,通常规定使用小写 (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |