avatar
统一账户管理系统RESTful api设计

统一账户管理系统RESTful api设计

星期五,四月 10 日,2015 年

LDAPAdmin, 为用户管理提供一组API,以HTTP-based RESTful API的形式提供服务,提供了对ldap数据的增删改查功能。主要用到了HTTP的四种方法:GET, POST, PUT和 DELETE。 下面主要对LDAPAdmin 的REST Api做个简单介绍: ##Functionality ###Terminology ###User stories 利用该组件的HTTP API,通过提交一组描述 用户/部门/系统/管理员的JSON数据,添加、删除、更新、查询数据; 利用该组件的HTTP API,可以方便的添加一条 用户/部门/系统/管理员记录; 利用该组件的HTTP API,可以方便的更新一条指定的 用户/部门/系统/管理员记录; 利用该组件的HTTP API,可以方便的将指定的 用户/部门/系统/管理员删除; ###Scope and Non-Scope ####Scope 用户/部门/系统/管理员 信息相关数据的添加、更新、删除; 查询 用户/部门/系统/管理员的信息; 用户/部门/系统/管理员 的有效性; ###Non-Scope 用户数据的可靠性,数据由管理员负责维护 ##Low-level Design ###Response Code Code Remind Description 200 OK – [GET] 成功返回用户请求的数据 201 CREATED – [POST/PUT] 新建/修改数据成功 204 NO CONTENT – [DELETE] 删除数据成功 400 INVALID REQUEST – [POST/PUT 用户发出请求有误,服务器没有新建/修改数据 401 Unauthorized – [*] token认证失败,token过期等情况 403 Forbidden – [*] 用户认证成功,但没有权限进行相应操作(权限细分) 404 NOT FOUND – [*] 请求的资源(在这里是表、字段不存在等情况) 406 NOT Acceptable – [GET] 用户请求的格式不可得 500 INTERNAL SERVER ERROR – [*] 服务器内部错误,用户无法判断请求是否成功 ###Response| Result #####除了每个响应都携带的返回码和可选的description字段,以下为该API的返回结果(具体形式在每种请求中都有举例):
@ 归零
4 分钟阅读

© 2014 - 2022 Lionel's Blog

Powered by Hugo with theme Dream.