• 电商 api 接口文档

    1、开篇

    欢迎使用ShowDoc！

    API格式：

    备注：API必须返回如下3个字段：

    参数名必选类型说明
    status是int状态
    message是string信息提示
    result否mix结果

    2、用户相关

    2.1、登录/退出

    简要描述：

    请求URL：

    • http://xx.com/api/login

    请求方式：

    • POST

    参数：

    参数名必选类型说明
    phone_number是int手机号码
    code是int验证码
    type类型tinyint1 ：7天 2：30天，默认传递2

    返回示例

    1. {
    2. status: 1,
    3. message: "OK",
    4. result: [ ]
    5. }

    返回参数说明

    简要描述：

    • 用户退出登录接口

    请求URL：

    • http://xx.com/api/logout

    请求方式：

    • POST GET

    • 备注

    • 更多返回错误代码请看首页的错误代码描述

      备注

    • 更多返回错误代码请看首页的错误代码描述

    2.2、发送验证码

    简要描述：

    • 获取短信验证码API

    请求URL：

    • http://xx.com/api/smscode

    请求方式：

    • POST

    参数：

    参数名必选类型说明
    phone_number是int手机号码

    返回示例

    1.   {
    2.     "status": 1,
    3.    "message":"发送成功",
    4.    "result":123
    5.   }

    返回参数说明

    参数名类型说明
    statusint状态：1成功， 0失败， -1不能重新发送
    messagestring消息提示

    备注

    • 更多返回错误代码请看首页的错误代码描述

    欢迎使用ShowDoc！

    2.3、个人中心

    简要描述：

    • 用户个人中心数据

    请求URL：

    • http://xx.com/api/user

    请求方式：

    • GET

    • 用户个人中心数据

    请求URL：

    • http://xx.com/api/user/1

    请求方式：

    • PUT

    参数：username:用户名 sex: 0:保密， 1男， 2女。

    备注

    • 更多返回错误代码请看首页的错误代码描述

    3、首页相关

    3.1、获取轮播图

    简要描述：

    • 获取轮播图

    请求URL：

    • http://xx.com/api/index/getRotationChart

    请求方式：

    • GET

      返回示例

    1.   {
    2. status: 1,
    3. message: "ok",
    4. result: [
    5. {
    6. id: 1,
    7. title: "abcd",
    8. image: "http://testmall.singwa.com/static/upload/image/1.jpg"
    9. },
    10. {
    11. id: 2,
    12. title: "abcd",
    13. image: "http://testmall.singwa.com/static/upload/image/3.jpg"
    14. },
    15. {
    16. id: 3,
    17. title: "abcd",
    18. image: "http://testmall.singwa.com/static/upload/image/3.jpg"
    19. },
    20. {
    21. id: 4,
    22. title: "abcd",
    23. image: "http://testmall.singwa.com/static/upload/image/5.jpg"
    24. },
    25. {
    26. id: 5,
    27. title: "abcd",
    28. image: "http://testmall.singwa.com/static/upload/image/5.jpg"
    29. }
    30. ]
    31. }

    点击轮播图跳转到详情页 xxx/api/detail/商品ID

    返回示例

    备注

    • 更多返回错误代码请看首页的错误代码描述

    欢迎使用ShowDoc！

    3.2、获取首页栏目推荐的商品

    简要描述：

    • 用户注册接口

    请求URL：

    • http://xx.com/api/index/cagegoryGoodsRecommend

    请求方式： -GET

    返回示例

    1、开篇

    欢迎使用ShowDoc！

    API格式：

    备注：API必须返回如下3个字段：

    参数名必选类型说明
    status是int状态
    message是string信息提示
    result否mix结果

    2、用户相关

    2.1、登录/退出

    简要描述：

    • 用户登录API

    请求URL：

    • http://xx.com/api/login

    请求方式：

    • POST

    参数：

    参数名必选类型说明
    phone_number是int手机号码
    code是int验证码
    type类型tinyint1 ：7天 2：30天，默认传递2

    返回示例

    1. {
    2. status: 1,
    3. message: "OK",
    4. result: [ ]
    5. }

    返回参数说明

    简要描述：

    • 用户退出登录接口

    请求URL：

    • http://xx.com/api/logout

    请求方式：

    • POST GET

    • 备注

    • 更多返回错误代码请看首页的错误代码描述

      备注

    • 更多返回错误代码请看首页的错误代码描述

    2.2、发送验证码

    简要描述：

    • 获取短信验证码API

    请求URL：

    • http://xx.com/api/smscode

    请求方式：

    • POST

    参数：

    参数名必选类型说明
    phone_number是int手机号码

    返回示例

    1.   {
    2.     "status": 1,
    3.    "message":"发送成功",
    4.    "result":123
    5.   }

    返回参数说明

    参数名类型说明
    statusint状态：1成功， 0失败， -1不能重新发送
    messagestring消息提示

    备注

    • 更多返回错误代码请看首页的错误代码描述

    欢迎使用ShowDoc！

    2.3、个人中心

    简要描述：

    • 用户个人中心数据

    请求URL：

    • http://xx.com/api/user

    请求方式：

    • GET

    • 用户个人中心数据

    请求URL：

    • http://xx.com/api/user/1

    请求方式：

    • PUT

    参数：username:用户名 sex: 0:保密， 1男， 2女。

    备注

    • 更多返回错误代码请看首页的错误代码描述

    3、首页相关

    3.1、获取轮播图

    简要描述：

    • 获取轮播图

    请求URL：

    • http://xx.com/api/index/getRotationChart

    请求方式：

    • GET

      返回示例

    1.   {
    2. status: 1,
    3. message: "ok",
    4. result: [
    5. {
    6. id: 1,
    7. title: "abcd",
    8. image: "http://testmall.singwa.com/static/upload/image/1.jpg"
    9. },
    10. {
    11. id: 2,
    12. title: "abcd",
    13. image: "http://testmall.singwa.com/static/upload/image/3.jpg"
    14. },
    15. {
    16. id: 3,
    17. title: "abcd",
    18. image: "http://testmall.singwa.com/static/upload/image/3.jpg"
    19. },
    20. {
    21. id: 4,
    22. title: "abcd",
    23. image: "http://testmall.singwa.com/static/upload/image/5.jpg"
    24. },
    25. {
    26. id: 5,
    27. title: "abcd",
    28. image: "http://testmall.singwa.com/static/upload/image/5.jpg"
    29. }
    30. ]
    31. }

    点击轮播图跳转到详情页 xxx/api/detail/商品ID

    返回示例

    备注

    • 更多返回错误代码请看首页的错误代码描述

    欢迎使用ShowDoc！

    3.2、获取首页栏目推荐的商品

    简要描述：

    • 用户注册接口

    请求URL：

    • http://xx.com/api/index/cagegoryGoodsRecommend

    请求方式： -GET

    返回示例

    1.   {
    2. status: 1,
    3. message: "ok",
    4. result: [
    5. {
    6. categorys: {
    7. category_id: 1,
    8. name: "女装",
    9. icon: "",
    10. list: [
    11. {
    12. name: "牛仔裤",
    13. category_id: 2
    14. },
    15. {
    16. name: "短裤",
    17. category_id: 2
    18. },
    19. {
    20. name: "休闲裤",
    21. category_id: 2
    22. },
    23. {
    24. name: "打底裤",
    25. category_id: 2
    26. },
    27. {
    28. name: "丝袜",
    29. category_id: 2
    30. }
    31. ]
    32. },
    33. goods: [
    34. {
    35. id: 1,
    36. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    37. price: 12.13,
    38. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    39. },
    40. {
    41. id: 2,
    42. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    43. price: 123.13,
    44. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    45. },
    46. {
    47. id: 1,
    48. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    49. price: 1256.1,
    50. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    51. },
    52. {
    53. id: 1,
    54. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    55. price: 4569,
    56. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    57. },
    58. {
    59. id: 1,
    60. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    61. price: 89.9,
    62. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    63. },
    64. {
    65. id: 1,
    66. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    67. price: 320.1,
    68. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    69. },
    70. {
    71. id: 1,
    72. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    73. price: 12.13,
    74. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    75. },
    76. {
    77. id: 1,
    78. title: "8原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    79. price: 458,
    80. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    81. },
    82. {
    83. id: 1,
    84. title: "9原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    85. price: 123,
    86. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    87. },
    88. {
    89. id: 1,
    90. title: "10原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    91. price: 345,
    92. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    93. }
    94. ]
    95. },
    96. {
    1.   {
    2. status: 1,
    3. message: "ok",
    4. result: [
    5. {
    6. categorys: {
    7. category_id: 1,
    8. name: "女装",
    9. icon: "",
    10. list: [
    11. {
    12. name: "牛仔裤",
    13. category_id: 2
    14. },
    15. {
    16. name: "短裤",
    17. category_id: 2
    18. },
    19. {
    20. name: "休闲裤",
    21. category_id: 2
    22. },
    23. {
    24. name: "打底裤",
    25. category_id: 2
    26. },
    27. {
    28. name: "丝袜",
    29. category_id: 2
    30. }
    31. ]
    32. },
    33. goods: [
    34. {
    35. id: 1,
    36. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    37. price: 12.13,
    38. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    39. },
    40. {
    41. id: 2,
    42. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    43. price: 123.13,
    44. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    45. },
    46. {
    47. id: 1,
    48. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    49. price: 1256.1,
    50. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    51. },
    52. {
    53. id: 1,
    54. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    55. price: 4569,
    56. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    57. },
    58. {
    59. id: 1,
    60. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    61. price: 89.9,
    62. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    63. },
    64. {
    65. id: 1,
    66. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    67. price: 320.1,
    68. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    69. },
    70. {
    71. id: 1,
    72. title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    73. price: 12.13,
    74. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    75. },
    76. {
    77. id: 1,
    78. title: "8原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    79. price: 458,
    80. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    81. },
    82. {
    83. id: 1,
    84. title: "9原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    85. price: 123,
    86. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    87. },
    88. {
    89. id: 1,
    90. title: "10原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
    91. price: 345,
    92. image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
    93. }
    94. ]
    95. },
    96. {
  • 相关阅读:
    Spring值IOC
    【App自动化测试】（十二）App异常弹框处理
    Mysql与Oracle分页查询差异
    01、spring入门简介
    亚马逊云科技云存储服务指南
    java中的深度复制和浅复制的BUG
    东方甄选三个月直播带货20亿
    Websocket学习
    设定并理解随机数种子 && Pytorch在Dataloader类中设置shuffle的随机数种子方式
    【node】初识node以及fs操作,path操作以及http操作（一）
  • 原文地址：https://blog.csdn.net/2301_79478575/article/details/133852276