user.raml 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. #%RAML 1.0
  2. /{userId}:
  3. uriParameters:
  4. userId:
  5. type: integer
  6. description: 用户id
  7. get:
  8. displayName: 获取用户信息
  9. is: [response: { typeName: User }]
  10. post:
  11. displayName: 更新用户信息
  12. body:
  13. application/json:
  14. properties:
  15. bio?: string
  16. nickname?: string
  17. is: [response: { typeName: User }]
  18. /password:
  19. post:
  20. displayName: 修改密码
  21. body:
  22. application/json:
  23. properties:
  24. oldPassword: string
  25. newPassword: string
  26. is: [response: { typeName: User }]
  27. /user:
  28. post:
  29. displayName: 管理员创建账号
  30. body:
  31. application/json:
  32. type: UserDTO
  33. is: [response: {typeName: User }]
  34. get:
  35. displayName: 管理员搜索用户列表
  36. is: [pagable, response: { typeName: PageUser }]
  37. queryParameters:
  38. search:
  39. type: string
  40. description: 搜索字符串
  41. /{userId}:
  42. uriParameters:
  43. userId:
  44. type: integer
  45. description: 用户id
  46. get:
  47. displayName: 管理员获取单个用户
  48. is: [response: { typeName: User }]
  49. delete:
  50. displayName: 管理员删除单个用户
  51. is: [empty_response]
  52. /current:
  53. displayName: 获取当前用户的信息
  54. is: [response: { typeName: User }]