userApi.ts 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. import { IApiDocInterface } from "../base/interface";
  2. const userApiDoc: IApiDocInterface = {
  3. "/wxMp/login": {
  4. funcName: "wxLogin",
  5. desc: "微信登录",
  6. get: {
  7. params: {
  8. code: { type: "String", desc: "小程序获取的code", required: true, },
  9. },
  10. response: {
  11. isReal: { type: 'number', desc: '', },
  12. showHome: { type: 'String', desc: '' },
  13. userMobile: { type: 'String', desc: '' },
  14. nickName: { type: 'String', desc: '' },
  15. inviteCode: { type: 'String', desc: '' },
  16. currentIdStatus: { type: 'number', desc: '' },
  17. headUrls: { type: 'String', desc: '' },
  18. userId: { type: 'number', desc: '' },
  19. token: { type: 'String', desc: '' },
  20. isRealNameNetLoan: { type: 'number', desc: '' }
  21. }
  22. }
  23. },
  24. "/api/v1/app/agreements": {
  25. funcName: "agreements",
  26. desc: "获取隐私政策",
  27. post: {
  28. body: {
  29. pageView: { type: "String", desc: "register_privacy", required: true },
  30. },
  31. response: [
  32. {
  33. name: { type: "String", desc: "名称", required: true },
  34. version: { type: "String", desc: "版本", required: true },
  35. selected: { type: "int", desc: "是否选择", required: true },
  36. url: { type: "String", "desc": "webview 地址", required: true },
  37. }
  38. ]
  39. }
  40. },
  41. "/api/v2/user/logoff": {
  42. funcName: "logOff",
  43. desc: "注销微信",
  44. post: {
  45. }
  46. },
  47. "/getIndexInfo/{appId}": {
  48. funcName: "getIndexInfo",
  49. desc: "微信登录",
  50. post: {
  51. params: {
  52. appId: { url: true, type: "String", desc: "Appid", required: true, },
  53. },
  54. response: {
  55. appId: { type: "String" },
  56. link: { type: "String", desc: "链接地址" },
  57. name: { type: "String", desc: "链接文案" },
  58. }
  59. }
  60. },
  61. "/api/v2/app/settings": {
  62. funcName: "homeTab",
  63. desc: "获取首页tabs",
  64. post: {
  65. body: {
  66. appId: { type: "String", desc: "Appid", required: true, },
  67. },
  68. response: {
  69. tabMenus: {
  70. type: "list",
  71. child: {
  72. id: { type: 'int', desc: '' },
  73. appid: { type: 'int', desc: '' },
  74. code: { type: 'String', desc: '' },
  75. name: { type: 'String', desc: '' },
  76. icon: { type: 'String', desc: '' },
  77. iconActive: { type: 'String', desc: '' },
  78. jumpTypeId: { type: 'int', desc: '' },
  79. jumpTarget: { type: 'String', desc: '' },
  80. status: { type: 'int', desc: '' },
  81. sort: { type: 'int', desc: '' }
  82. }
  83. },
  84. articleCategories: {
  85. type: "list",
  86. child: {
  87. id: { type: 'int', desc: '' },
  88. name: { type: 'String', desc: '' },
  89. sort: { type: 'int', desc: '' },
  90. status: { type: 'int', desc: '' },
  91. createBy: { type: 'String', desc: '' },
  92. updateBy: { type: 'String', desc: '' },
  93. createTime: { type: 'String', desc: '' },
  94. updateTime: { type: 'String', desc: '' }
  95. }
  96. }
  97. }
  98. }
  99. },
  100. }
  101. export default userApiDoc;