《诗词达人》接口文档

以下接口如无特殊说明,调用url统一为https://fl123.xyz/api/poetry/****.php.下面是各文件的详细说明

getPoList 获取诗词库

功能:获取诗词库的列表,返回值是诗词的名字的集合。如果传递了参数,则通过参数寻找对应的库,比如传递参数为‘一年级下册’,那么就返回一年级下册的诗词名数组。默认是不带参数的,即返回数据库中所有诗词名字。
参数列表

library='诗词库名';

实例

test = open('GET','https://fl123.xyz/poetry/getPoList.php?libarary=一年级下册',true);
//返回值
//json对象
{
	"title":"诗名",
    "writer":"作者"
}

getPoetry 获取诗词详细数据

功能:获取一首诗的具体数据。
参数列表

poetryName='诗名';
poemName=‘作者’;

实例

test = open('GET','https://fl123.xyz/poetry/getPoetry.php?poetryName=静夜思&poemName=李白',true);
//返回值
 		"finishState":"finishState",//学习情况
		"grade":"所属词库",
		"title":"诗名",
		"img":"诗词图片",
		"writer":"作者",
		"writerImg":"作者图片",
		"writerDynasty":"朝代",
		"content":"正文",
		"writerStory":"诗人生平",
		"content":"正文",
		"comments":"正文翻译",
		"comments2":"注释",
		"appreciation":"解析",

getTest 获取诗词练习数据

功能:获取练习的诗词数据。
参数列表

无参数
//返回值
[
 		{
 			"title":"诗名",//第一题
			"quesion":"问题",
			"answer":"诗名",
			"imgUrl":"图片"
		},
		{
 			"title":"诗名",//第二题
			"quesion":"问题",
			"answer":"诗名",
			"imgUrl":"图片"
		},
		...
]

getDaily 获取每日一句诗词数据

功能:获取每日一句的诗词数据。
参数列表

无参数
//返回值
[
 		{
 			"title": "诗名",//第一句
			"poem": "诗词内容",
			"winter": "作者",
			"dynasty": "朝代",
			"stampHeight": "120px",//前端要求
			"leftOut": false,//前端要求
			"rightOut": false//前端要求
		},
		{
 			"title":"诗名",//第二句
			"poem": "诗词内容",
			"winter": "作者",
			"dynasty": "朝代",
			"stampHeight": "120px",//前端要求
			"leftOut": false,//前端要求
			"rightOut": false//前端要求
		},
		...
]

register注册用户

功能:通过post方式传递参数,注册用户,目前只支持手机号或者邮箱号。接口会识别传递的注册账号account是手机号还是邮箱号,并且用户名账号/邮箱号 都是不可重复的。
参数列表

userName='注册用户名';
account='注册账户号';
password='密码';

此接口返回值较多,分为以下几种情况

//用户选择的昵称已被使用
‘该昵称已被注册!’
//用户注册的手机号已被使用
‘该手机号已被注册!!’
//用户注册的邮箱号已被使用
‘该邮箱号已被注册!’
//注册成功
1

login用户登录

功能:通过post方式传递参数,用户使用已注册的手机号或者邮箱号登录。返回的信息可用于个人信息的填充。
参数列表

userId='账户';
password='密码';

json返回格式

[
		"userName":"userName",//用户昵称
		"phone":"phone",//手机号(可有)
		"message":"message",//用户信息
		"img":"img",//头像url
		"sex":"sex",//性别
		"email":"email",//邮箱号(可有)
		"openid":"openid",//用户id		
]


loginOut退出登录

功能:退出登录,清除session,退出登录时调用。

你可能感兴趣的:(《诗词达人》接口文档)