安卓课设——新闻阅读器
实现了:登录、注册、新闻详情
- 要求数据从云端拉取,于是顺便写了新闻的接口。Spring Boot 编写挺快的。
- 开放下面的接口给需要的朋友练习
- 文档原先是用语雀写的(语雀的体验真的非常好),现在有空就顺便粘贴过来的。
注意:当你看到这篇文章时,请点击这里测试是否可用,如果看到一串 JSON,说明可用。永远不知道,明天和停止维护,还有多远。
新闻 API 文档
约定
- Content-Type 为
application/x-www-form-urlencoded
, 通过urlencode
格式化请求体。 - 响应报文为
JSON
注册
接口描述:用户注册,必要的参数:用户名,密码
HTTP 方法:POST
请求 URL:https://challage.cn/guet/api/user/register
注册请求说明
参数 | 是否必需 | 长度范围 | 说明 |
---|---|---|---|
userName | 是 | 0-50 | 用户名 |
userPassword | 是 | 0-50 | 密码 |
userNikeName | – | 0-50 | 昵称 |
userImg | – | 0-50 | 头像 URL (需要存储接口配合,暂缺省) |
userMore | – | 0-50 | 预留字段,可用作自我介绍等 |
注册返回说明
参数 | 是否必需 | 值说明 |
---|---|---|
registerMsg | 是 | 注册结果信息 |
userId | 是 | 成功时返回 userId,失败时返回 -1 |
注册成功示例(userId>0):
请求参数:
userName: 张三
userPassword:407
响应:
{
"registerMsg": "注册成功",
"userId": 62
}
注册失败示例(userId == -1):
请求参数:
userName: 张三
userPassword:407
响应:
{
"registerMsg": "用户名已存在",
"userId": -1
}
注册参数不合法示例(userId == -1):
请求参数:
userName: 张三
userPassword:null
响应:
{
"registerMsg": "用户名和密码不能为空",
"userId": -1
}
登录
接口描述:用户登录,必要的参数:用户名,密码
HTTP 方法:POST
请求 URL:https://challage.cn/guet/api/user/login
返回说明
参数 | 是否必需 | 值说明 |
---|---|---|
loginMsg | 是 | 登录结果信息 |
userInfo | 是 | 成功时返回用户 POJO,登录失败时为 null |
登录成功示例(注意,因为返回用户 POJO 映射,考虑安全而将密码置空):
请求参数:
userName:pan
userPassword:123456
响应:
{
"loginMsg": "登录成功",
"userInfo": {
"userId": 1,
"userName": "pan",
"userPassword": null,
"userNikeName": "潘裤衩",
"userImg": "https://upload.jianshu.io/users/upload_avatars/2027280/6f5e986b-1eec-45c7-a512-4b51854595d9.jpg?imageMogr2/auto-orient/strip|imageView2/1/w/96/h/96",
"userRegisterTime": "2019-06-12 22:45",
"userMore": "自我介绍~"
}
}
登录失败响应示例:
请求参数
userName:pan
userPassword:666
响应
{
"loginMsg": "登录失败,用户名或密码错误",
"userInfo": null
}
登录参数不合法响应示例:
请求参数:
userName:pan
userPassword:null
响应:
{
"loginMsg": "登录失败,用户名或密码错误",
"userInfo": null
}
获取新闻详情
接口描述:通过 news_id 获取新闻详情
HTTP 方法:POST/GET
请求 URL:https://challage.cn/guet/api/news/detail/news_id
参数以 RESTFUL 格式携带于 URL 中,news_id
为 Integer 类型参数
例如 https://challage.cn/guet/api/news/detail/2
含义:new_id 为 2 的新闻详情
响应结果说明:
参数 | 是否可能为空 | 说明 |
---|---|---|
newsId | 否 | news_id |
newsTitle | 否 | 标题 |
newsSubtitle | 是 | 副标题 |
newsAuthor | 是 | 作者 |
newsCover | 是 | 封面图 URL |
newsType | 是 | 新闻类型 |
newsPublishTime | 是 | 新闻发布时间 |
newsContent | 否 | 新闻内容 |
newMore | 是 | 预留字段 |
新闻返回成功示例:
请求参数: https://challage.cn/guet/api/news/detail/2
{
"newsId": 2,
"newsTitle": "刘鹤:中国经济长期向好趋势不变 外部压力有利发展",
"newsSubtitle": "原标题:刘鹤:中国经济长期向好的趋势不会改变,外部压力有利发展",
"newsAuthor": "中国经济网",
"newsCover": "https://imgsa.baidu.com/news/q%3D100/sign=6dfce06a5fda81cb48e687cd6267d0a4/3812b31bb051f819468a0bd4d4b44aed2f73e785.jpg",
"newsType": "经济",
"newsPublishTime": "2019-06-13 11:27",
"newMore": "缺省字段",
"newsContent": "在第十一届陆家嘴论坛上,国务院副总理刘鹤表示,中国经济长期向好的趋势不会改变,外部压力有利发展。\r\n\r\n 他说,要加大金融对经济高质量发展的支持,这件事至关重要,中国经济已经从高速增长阶段转变为高质量发展阶段。\r\n\r\n 一是供给体系要不断优化。40 年改革开放中国已经形成完整的产业体系,进入新的发展阶段,需要我们深化供给侧结构性改革,强化公平的市场环境,增强科技创新在经济发展中的作用,增强企业家在经济发展中的引领作用,大力提高制造业、服务业,形成国际分工产业链的完整性,使现代产业大趋势进一步延伸。\r\n\r\n 二是需求体系需要进一步升级。庞大的中等收入群体正在形成,我国目前中等收入有 4 亿,有住房汽车稳定工作,需求各具特色,高度重视质量。目前中国已是全世界最大的成长性市场,为全世界提供机会。\r\n\r\n 三是金融体系要高质量适配。目前金融正在进行供给侧改革,要加大直接融资比例,提高金融适应性、竞争性、普惠性。\r\n\r\n 他指出,供给、需求和金融是三角框架,在全球化背景下,它们是开放的系统而不是封闭的系统。三者相互支撑的过程中,中国经济形成了良好态势,中国经济再平衡正在持续推进,取得了全面进展。\r\n\r\n 他表示,下一阶段金融工作主要聚焦几个方面:\r\n\r\n 第一,回归本源,坚定服务实体经济,提高金融供给的适应性。第二,打好防范化解金融风险攻坚战,注意把握好处置风险的力度和节奏。第三,实施好金融调控,加强货币政策、宏观审慎政策、微观审慎监管的协调配合。第四,强化金融基础设施建设。统筹规划,加强信息共享。第五,进一步加快改革开放。加快推进市场准入、平等竞争、保护产权和知识产权。\r\n\r\n 他透露,这次论坛上,有关部门将宣布一系列金融改革开放的举措。"
}
新闻返回失败示例:
请求参数: https://challage.cn/guet/api/news/detail/25
null
获取最新 20 条新闻
预留开发
新闻收藏
预留开发