欢迎使用CSDN-markdown编辑器 (1)

目录

• 1.备注
  
  • 1.1请求参数说明
  • 1.2响应参数说明
  • 1.3返回参数说明
• 2.前端
  
  • 2.1获取版区页数据
  • 2.2获取获取帖子数据
  • 2.3点赞、反对、分享和收藏点击事件后响应
  • 2.4获取用户个人主页数据
  • 2.5发帖

一、 备注

1. 请求参数说明:

参数名 类型 是否必选 说明 xxx string 是 xxx

2. 响应参数说明:

返回键 类型 返回值 说明 code string 2000 返回结果代号 response object 响应体

3. 返回参数说明

Code返回结果代号:

代码 说明 2000 成功 1000 服务器处理失败 1001 HTTP请求方式错误 1002 请求参数格式错误 1003 未授权访问

自定义http状态码:

代码 说明 429 访问太频繁

自定义Http头:

键 说明 RateLimit-Limit 每分钟内允许请求的最大次数 X-RateLimit-Remaining 这分钟内允许请求的剩余次数 Retry-After 距离下次请求剩余时间(s)

二、 前端：

1. 获取版区页数据

描述:根据版区id获取版区页数据
请求地址：/getAllPostings
请求方式：GET
请求参数：

参数名 类型 说明 id string 版区id

请求示例:

{        "id":"1"    }

响应参数:

参数名 类型 说明 allthemes_num string 帖子的id all_postings (array)object 全部帖子 type string 帖子种类 theme_name string 帖子主题名字 writer_name string 作者名字 posting_date string 发帖日期 reply_num string 回复该帖数目 read_num string 查看该帖数目 last_post_name string 最后发表人名 last_post_date string 最后发表日期 today_postings_num string 今天的发帖数 id string 全部主题数

响应示例:

   {    "code":"2000",    "response":{        "all_postings":[{            "id":"1",            "type":"原创",            "theme_name":"你好!我是标题",            "writer_name":"胡伟",            "posting_date":"2017-9-21",            "reply_num":"5",            "read_num":"10",            "last_post_name":"无名氏",            "last_post_date":"2017-9-21 20:34"                  }]        "today_postings_num":"10",        "allthemes_num":"100"             }    } 

2. 获取获取帖子数据

描述:根据帖子id获取帖子数据
请求地址：/getPosting
请求方式：GET
请求参数：

参数名 类型 说明 id string 帖子id

请求示例:

{        id:"1"    }

响应参数:

参数名 类型 说明 thumbs_up string 点赞数 thumbs_down string 反对数 share_num string 分享数 collection_num string 收藏数 posting_user object(array) 帖子回复的用户 username string 用户名字 usericon string 回复该帖数目 user_posting_num string 用户发帖数 user_posting_money string 用户PB币 user_posing_grade string 用户等级 user_content string 用户发表内容 user_date string 用户发表时间

响应示例:

  {        "code":"2000",        "response":{            "posting_user":[{                "username":"胡伟",                "user_content":"帖子的内容",                "user_date":"2017-9-20 15:45:14",                "usericon":"/img",                "user_posting_num":"100",                "user_posting_money":"1000",                "user_posing_grade":"10",                   },{                "username":"无名氏",                "user_content":"评论的内容",                "user_date":"2017-10-25 17:45:14",                "usericon":"/img1",                "user_posting_num":"101",                "user_posting_money":"120",                "user_posing_grade":"1",                    }],            "thumbs_up":"50",            "thumbs_down":"10",            "share_num":"20",            "collection_num":"100"        }    }   

3. 点赞、反对、分享和收藏点击事件后响应

描述:点赞、反对、分享和收藏点击事件后响应
请求地址：/clickReponse
请求方式：post
请求参数：

参数名 类型 说明 id string 帖子id username string 进行点击事件的用户名

请求示例:

{        "id":"1",        "username":"q479902964"    }

响应参数:

参数名 类型 说明 thumbs_up string 点赞数 thumbs_down string 反对数 share_num string 分享数 collection_num string 收藏数

请求示例:

{        "code":"2000",        "response":{                "thumbs_up":"50",                "thumbs_down":"10",                "share_num":"20",                "collection_num":"100"        }    }

4. 获取用户个人主页数据

描述:根据用户名获取用户个人主页数据
请求地址：/getPersonalData
请求方式：get
请求参数:

参数名 类型 说明 username string 用户名

请求示例:

 {        "username":"q479902964"    }

响应参数:

参数名 类型 说明 industry string 行业 position string 职位 real_name string 真实姓名 nick_name string 昵称 username string 用户名 birthday string 出生日期 region string 地区 sex string 性别 content string 个人简述 concern_num string 关注量 fans_num string 粉丝量 my_postings (array)object 我的帖子 posting_theme string 帖子的主题 posting_date string 发帖日期 posting_id string 帖子id

响应示例:

{        "code":"2000",        "response":{            "industry":"IT行业",            "position":"web前端开发人员",            "real_name":"胡伟",            "nick_name":"伟hu",            "username":"q479902964",            "birthday":"2017-09-14",            "region":"中国-广东省-广州市",            "sex":"男",            "content":"个人描述个人描述个人描述",            "concern_num":"100",            "fans_num":"0",            "my_postings":[{                "posting_id":"1",                "posting_theme":"帖子主题",                "posting_date":"2016-9-13"            },            {                "posting_id":"2",                "posting_theme":"帖子主题",                "posting_date":"2017-09-22 13:17:51"            }]        }    }

5. 发帖

描述:发帖
请求地址：/postPosting
请求方式：post
请求参数:

参数名 类型 说明 username string 用户名 type string 帖子类型(原创、转载、翻译三种) content string 帖子文字内容 picture file 帖子图片内容

请求示例:

{        "username":"q479902964",        "type":"原创",        "content":"帖子内容帖子内容帖子内容",        "picture":"/img"    } 

响应示例:

{        "code":"2000"    }

6. 用户登录

描述:发送用户用户名密码和验证问题到后台
请求地址：/login
请求方式：post
请求参数:

参数名 类型 说明 username string 用户名 password string 密码 question string 安全提问 answer string 答案

请求示例:

{    "username":"q479902964"    "password":"*******"    "question":"你最喜欢的餐馆名称"    "answer":"外婆家"}

响应示例:

{        "code":"2000"    }

6. 用户注册

描述:发送用户注册信息到后台
请求地址：/register
请求方式：post
请求参数:

参数名 类型 说明 username string 用户名//是否已用 password string 密码//位数是否合理 email string 邮箱//是否有效或是否已用

请求示例：

{    "username":"q479902964",    "password":"*******",    "email":"^[A-Za-zd]+([-_.][A-Za-zd]+)*@([A-Za-zd]+[-.])+[A-Za-zd]{2,5}$"}

响应示例:

{        "code":"2000"    }