#后端API文档
##php/article.php?action=get_default_page
- 描述:获取默认页(第一个未经page review的页)
- 请求方式:GET
- 请求参数:无
- 返回参数:
- state: 状态码(200:OK,404:找不到页,-1:请求参数不合法)
- article_name: 文章标题(一个文章标题对应多页)
- page_number: 当前页的索引号(最小值为0)
- article_full_text: 当前页的完整文本内容
- article_image: 当前页的图片URL(相对路径)
- page_reviewed: 当前页是否已被核对(“Y”:以核对 ,“N”:未核对)
- final_reviewed: 该文章是否已被核对(“Y”:以核对 ,“N”:未核对)
- 返回示例:
{
"state": 200,
"article_name": "inter_med",
"page_number": "0",
"article_full_text": "主 编\n编 者\n\n王京华\n刘远厚\n吴 婷\n李小刚\n杨明功\n武明虎\n郝玉明\n高兴玉\n黄良国\n黄建安\n赖永榕\n\n全国高等学校医学规划教材\n\n成人教盲〉\n、 卢隼今\n内 科 子\n\n刘远厚\n\n〈以姓氏笔画为序〉\n\n哈尔滨医科犬学 吕农华 江西医学院\n泸州医学院 邢昌赢 南京医科犬学\n福建医科犬学 李 舒 锦州医学院\n泸州医学院 陈少贤 温州医学院\n安徽医科犬学 周敬群 三峡犬学医学院\n山西医科犬学 赵 敏 中国医科犬学\n河北医科犬学 高犬中 重庆医科犬学\n川北医学院 高继东 青海医学院\n遭义医学院 黄宗青 泰山医学院\n苏州犬学医学院 谢汊华 扬州犬学医学院\n广西医科犬学\n\n学术秘书 李 刚 陈丽娜 张建堂 泸州医学院〉\n\n高等教盲 出 版社\nHiqher Education Press\n\n凿\n",
"article_image": "php/article_image.php?article_name=inter_med&page_number=0",
"page_reviewed": "N",
"final_reviewed": "N"
}
- 调用示例(JQuery):
$.get('php/article.php?action=get_default_page', function(data){
if (data.state == 200) {
//如果返回对象中state字段的值为200,即请求成功
//依次在控制台中打印当前页索引号、文章标题、当前页文本内容
console.log(data.page_number);
console.log(data.article_name);
console.log(data.article_full_text);
}
});
##php/article.php?action=get_article_page
- 描述:获取指定文章的指定页
- 请求方式:GET
- 请求参数(注意:传GET参数时请先经过urlencode,下同):
- article_name: 文章标题
- page_number: 页面的索引号
- 返回参数:同上
- 示例请求URL:
php/article.php?action=get_article_page&article_name=inter_med&page_number=2
- 返回示例: 同上
##php/article.php?action=get_max_page
- 描述:获取指定文章的最大页索引号
- 请求方式:GET
- 请求参数:
- article_name: 文章标题
- 返回参数:
- state: 状态码(200:OK,404:文章标题不存在)
- 示例请求URL:
php/article.php?action=get_max_page&article_name=inter_med
- 返回示例:
{
"state": 200,
"max_page": "722"
}
##php/article.php?action=review_page
- 描述:核对指定页,并保存该页内容
- 请求方式:POST
- 请求参数:
- article_name: 文章标题
- page_number: 页面索引号
- full_text: 用户修改后的该页完整文本内容,此将保存到数据库,替换原文本内容
- 返回参数:
- state: 状态码(200:成功,0:该页已经被核对,-1:输入参数不合法)
- 调用示例(JQuery):
$.post('php/article.php?action=review_page',
{
'article_name' : 'inter_med',
'page_number' : 0,
'full_text' : '测试文本内容'
},
function(data){
if (data.state == 200) {
alert('成功!');
}
});
##php/article.php?action=review_article
- 描述:核对指定文章的全部页面(调用后该文章的全部页面的“page_reviewed”和“final_reviewed”都被设为"Y"),并保存当前页内容
- 请求方式:POST
- 请求参数:
- article_name: 文章标题
- page_number: 当前页面索引号
- full_text: 用户修改后的该页完整文本内容,此将保存到数据库,替换原文本内容
- 返回参数:
- state: 状态码(200:成功,0:该文章已经被核对,-1:输入参数不合法)
##php/article_image.php
- 描述:获取指定文章的指定页面的图片
- 请求方式:GET
- 请求参数:
- article_name: 文章标题
- page_number: 页面的索引号
- 返回:
若图片存在则返回图片的binary,并设置http header为Content-type: image/jpg
,若图片不存在,返回以下JSON:
{
"state": 404,
"message": "Page image not found."
}