www.gusucode.com > baigo CMS PHP开源网站管理系统 v1.2.2源码程序 > baigocms_v1.2.2/bg_core/lang/zh_CN/help/api/article.php
<?php
return "<a name=\"list\"></a>
<h3>文章列表</h3>
<p class=\"text-info\">接口说明</p>
<p>用于显示文章列表。</p>
<p class=\"text-info\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/bg_api/api.php?mod=article</span></p>
<p class=\"text-info\">HTTP 请求方式</p>
<p>GET</p>
<p class=\"text-info\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_get</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 list。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>搜索关键词</td>
</tr>
<tr>
<td class=\"text-nowrap\">year</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>年份</td>
</tr>
<tr>
<td class=\"text-nowrap\">month</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>月份</td>
</tr>
<tr>
<td class=\"text-nowrap\">cate_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">false</td>
<td>栏目 ID</td>
</tr>
<tr>
<td class=\"text-nowrap\">mark_ids</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>标记 ID，多个 ID 请使用 <kbd>|</kbd> 分隔。</td>
</tr>
<tr>
<td class=\"text-nowrap\">spec_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">false</td>
<td>专题 ID。</td>
</tr>
<tr>
<td class=\"text-nowrap\">tag_ids</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>TAG ID，多个 ID 请使用 <kbd>|</kbd> 分隔。此参数与下一项参数 <mark>customs</mark> 为二选一，当本参数不为空时，自动忽略 <mark>customs</mark> 参数。</td>
</tr>
<tr>
<td class=\"text-nowrap\">customs</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=tpl&act_get=search#customs\" target=\"_blank\">搜索</a></td>
</tr>
<tr>
<td class=\"text-nowrap\">per_page</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">false</td>
<td>每页显示文章数</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果</h4>
<div class=\"panel panel-default\">
<div class=\"table-responsive\">
<table class=\"table\">
<thead>
<tr>
<th class=\"text-nowrap\">键名</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">说明</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">articleRows</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">文章列表</td>
<td>符合搜索条件的所有文章。详情请查看 <a href=\"#result\">文章显示返回结果</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pageRow</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">分页参数</td>
<td>详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=page\" target=\"_blank\">分页参数</a>。</td>
</tr>
</tbody>
</table>
</div>
</div>
<hr>
<a name=\"get\"></a>
<h3>文章显示</h3>
<p class=\"text-info\">接口说明</p>
<p>用于显示当前文章的详细信息。</p>
<p class=\"text-info\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/bg_api/api.php?mod=article</span></p>
<p class=\"text-info\">HTTP 请求方式</p>
<p>GET</p>
<p class=\"text-info\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_get</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 list。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">article_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>文章 ID</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<a name=\"result\"></a>
<h4>返回结果</h4>
<div class=\"panel panel-default\">
<div class=\"table-responsive\">
<table class=\"table\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">说明</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">article_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">文章 ID</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_title</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">文章标题</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_content</td>
<td class=\"text-nowrap\">text</td>
<td class=\"text-nowrap\">文章内容</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_cate_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">隶属栏目 ID</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_mark_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">隶属标记 ID</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_spec_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">文章隶属专题 ID</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_excerpt</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">文章摘要</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_link</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">跳转至</td>
<td>如填写了跳转地址，该文章将直接跳转至相应的地址，不会显示文章内容。</td>
</tr>
<tr>
<td class=\"text-nowrap\">article_hits_day</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">一天点击数</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_hits_week</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">一周点击数</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_hits_month</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">一月点击数</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_hits_year</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">一年点击数</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_hits_all</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">总点击数</td>
<td> </td>
</tr>
<tr>
<td class=\"text-nowrap\">article_time</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">文章添加时间</td>
<td>指文章添加到数据库的时间。</td>
</tr>
<tr>
<td class=\"text-nowrap\">article_time_pub</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">文章发布时间</td>
<td>指文章发布时间。</td>
</tr>
<tr>
<td class=\"text-nowrap\">tagRows</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">当前文章关联的 TAG</td>
<td>所有与此文章关联的 TAG。详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=tag#tagRow\" target=\"_blank\">TAG</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">cateRow</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">当前文章所属栏目的详细信息</td>
<td>详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=cate#cateRow\" target=\"_blank\">栏目</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">attachRow</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">当前文章附件的详细信息</td>
<td>详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=attach\" target=\"_blank\">附件</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">article_status</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">文章状态</td>
<td>pub 为发布，wait 为待审，hide 为隐藏。</td>
</tr>
<tr>
<td class=\"text-nowrap\">article_customs</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">自定义字段</td>
<td>自定义字段的内容。用 <code>article_customs[\"custom_自定义字段 ID\"]</code> 的方法便可获取自定义字段的内容。详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=custom\" target=\"_blank\">自定义字段</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">返回代码</td>
<td>显示当前文章的状态，详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\" target=\"_blank\">返回代码</a>。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"article_id": "62", //文章 ID
"article_cate_id": "2", //隶属栏目 ID
"article_mark_id": "0", //标记 ID
"article_title": "文章标题", //标题
"article_excerpt": "<p><img id=\"baigo_2662\" class=\"img-responsive\" src=\"/cms/bg_attach/2015/07/2662.jpg\" alt=\"\" /></p>", //摘要
"article_status": "pub", //状态
"article_link": "", //链接
"article_hits_day": "0", //日点击
"article_hits_week": "0", //周点击
"article_hits_month": "0", //月点击
"article_hits_year": "5", //年点击
"article_hits_all": "6", //总点击
"article_time": "1438309806", //添加时间
"article_time_pub": "1438308780", //发布时间
"article_spec_id": "11", //隶属专题 ID
"article_attach_id": "2662", //附件 ID
"article_content": "<p><img id=\"baigo_2662\" class=\"img-responsive\" src=\"/cms/bg_attach/2015/07/2662.jpg\" alt=\"\" /></p><p> </p><p>[hr]</p>", //内容
"article_customs": { //自定义字段
"custom_4": "0",
"custom_3": "0",
"custom_5": "0",
"custom_6": "0",
"custom_8": "0",
"custom_9": "",
"custom_11": "",
"custom_12": ""
},
"article_url": "/cms/article/id-62", //URL
"cateRow": { //隶属栏目信息
"alert": "y110102",
"cate_id": "2",
"cate_name": "技术支持",
"cate_alias": "support",
"cate_parent_id": "0",
"cate_type": "normal",
"cate_tplDo": "default",
"cate_content": ""
"urlRow": {
"cate_url": "/cms/cate/support/id-2/",
"page_attach": "page-"
},
"cate_trees": {
[
"0": {
"cate_id": "2",
"cate_name": "技术支持",
"cate_alias": "support",
"cate_domain": "",
"urlRow": {
"cate_url": "/cms/cate/support/id-2/",
"page_attach": "page-"
}
}
]
}
},
"tagRows": { //TAG
},
"attachRow": { //附件信息
"attach_id": "2662",
"attach_name": "20080228_765bd81512e1d286d713fnYZzWPWCwbf.jpg",
"attach_time": "1438308616",
"attach_ext": "jpg",
"attach_mime": "image/jpeg",
"attach_size": "42996",
"attach_type": "image",
"attach_url": "/cms/bg_attach/2015/07/2662.jpg",
"thumb_100_100_cut": "/cms/bg_attach/2015/07/2662_100_100_cut.jpg",
"thumb_150_2000_ratio": "/cms/bg_attach/2015/07/2662_150_2000_ratio.jpg",
"thumb_200_200_ratio": "/cms/bg_attach/2015/07/2662_200_200_ratio.jpg",
"thumb_500_500_cut": "/cms/bg_attach/2015/07/2662_500_500_cut.jpg",
"alert": "y070102"
},
"alert": "y120102"
}</code></pre>
</p>";