做最好的文档分享网站
顶部右侧自定义文字
广告位 后台主题配置管理

网站首页 网站源码 正文

Emlog API设计文档

小木 2021-08-31 网站源码 277 ℃ 0 评论

本API文档说明

有些Emlog模板的制作需要用到Ajax去异步调用数据,此时免不了要去写一些接口,模板制作的时候去写接口调用,无疑增加了开发者的工作量。于是我就想先规范一些Emlog的API接口的调用方式,然后制作一款API接口插件,这样可以减少模板开发者的技术负担,专注于界面的设计。

使用方式

1. 将API文件解压放入网站根目录

2. Ajax访问 `BLOG_URL + 'api.php?route=请求地址&请求参数` 即可

3. 拼接地址大概如: https://域名/api.php?route=article&sid=1

获取文章列表

请求方式: GET

请求地址: article

请求参数:

sid 分类ID 可选,无sid则获取所有分类最新的文章

page 页码

perpage 每页条数 默认从emlog配置中取

top 是否仅获取首页置顶文章

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data: {
                total: 100, // 总数
                list: [
                        {
                                gid: 1, // 文章ID
                                title: '', // 文章标题
                                date: 1527669094, // 发布时间,unix时间戳
                                excerpt: '', // 描述
                                author: 1, // 作者ID
                                nickname: '', // 作者昵称
                                sortid: -1, // 分类ID
                                sortname: '未分类', // 分类名称
                                views: 100, // 浏览数
                                comnum: 100, // 评论数
                                top: 'n', // 首页置顶 n 不置顶 y 置顶
                                sortop: 'n', // 分类置顶 n 不置顶 y 置顶
                        }
                ]
        }
}

获取文章/页面详情

请求方式: GET

请求地址: articleInfo

请求参数:

gid = 1 文章id

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data: {
                total: 100, // 总数
                list: [
                        {
                                gid: 1, // 文章ID
                                title: '', // 文章标题
                                date: 1527669094, // 发布时间,unix时间戳
                                excerpt: '', // 描述
                                author: 1, // 作者ID
                                nickname: '', // 作者昵称
                                sortid: -1, // 分类ID
                                sortname: '未分类', // 分类名称
                                views: 100, // 浏览数
                                comnum: 100, // 评论数
                                top: 'n', // 首页置顶 n 不置顶 y 置顶
                                sortop: 'n', // 分类置顶 n 不置顶 y 置顶
                        }
                ]
        }
}

获取文章/页面详情

请求方式: GET

请求地址: articleInfo

请求参数:

gid = 1 文章id

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data: {
                gid: 1, // 文章id
                title: '', // 文章标题
                date: 1527669094, // 发布时间,unix时间戳
                content: '', // 内容
                sortid: 1, // 分类id
                sortname: 'xx', // 分类名称
                views: 100, // 浏览数
                comnum: 100, // 评论数
                author: 1, // 作者id
                nickname: '', // 作者昵称
                allow_remark: 'y', // 是否允许评论
                tags: [
                        {
                                tid: 1,
                                tagname: ''
                        }
                ] // 标签
        }
}

获取某文章/页面关联的评论列表

请求方式: GET

请求地址: comments

请求参数:

gid 文章ID

page 评论页码

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data: {
                total: 100, // 评论总数
                list: [
                        {
                                cid: 1, // 评论ID
                                date: 1527138590, // 评论时间
                                poster: 'admin', // 评论者昵称
                                comment: '评论内容', // 评论内容
                                children: [ // 子评论
                                        {
                                                cid: 1, // 评论ID
                                                date: 1527138590, // 评论时间
                                                poster: 'admin', // 评论者昵称
                                                comment: '评论内容', // 评论内容
                                                children: []
                                        }
                                ]
                        }
                ]
        }
}

发表评论

请求方式: POST

请求地址: addComments

请求参数:

gid 文章ID

poster 评论者昵称

mail 评论者邮箱 选填

url 评论人个人主页 选填

comment 评论内容

imgcode 验证码

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data: {
                total: 100, // 评论总数
                list: [
                        {
                                cid: 1, // 评论ID
                                date: 1527138590, // 评论时间
                                poster: 'admin', // 评论者昵称
                                comment: '评论内容', // 评论内容
                                children: [ // 子评论
                                        {
                                                cid: 1, // 评论ID
                                                date: 1527138590, // 评论时间
                                                poster: 'admin', // 评论者昵称
                                                comment: '评论内容', // 评论内容
                                                children: []
                                        }
                                ]
                        }
                ]
        }
}

验证码

地址: http://BLOG_URL/include/lib/checkcode.php

当成图片引入显示就行

如: <img src="http://BLOG_URL/include/lib/checkcode.php" />

获取最新评论

从所有评论离获取几条最新的

请求方式: GET

请求地址: newComments

请求参数: -

说明: 条数可在后台侧边栏设置:最新评论

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data:  [
                {
                        cid: 1, // 评论ID
                        gid: 1,
                        date: 1527138590, // 评论时间
                        name: 'admin', // 评论者昵称
                        content: '评论内容' // 评论内容
                }
        ]
}

获取最新微语

请求方式: GET

请求地址: twitter

请求参数:

page 页码

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data:  {
                total: 100, // 总数
                list: [
                        {
                                id: 1, // 微语ID
                                content: '', // 微语内容
                                img: '', // 微语包含的图片地址
                                author: 1, // 微语作者ID
                                nickname: '', // 微语作者昵称
                                date: '2013-04-04 10:58', // 发布时间
                                replynum: 5, // 几条回复
                                t: '' // 替换表情处理过的内容
                        }
                ]
        }
}

获取微语回复

请求方式: GET

请求地址: replyTwitter

请求参数:

tid 微语ID

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data:  [
                {
                        id: 1, // 回复ID
                        content: '', // 回复内容
                        name: '', // 回复者昵称
                        date: '2018-06-21 16:02' // 回复时间
                }
        ]
}

获取分类列表

请求方式: GET

请求地址: sorts

请求参数: -

响应数据:

{
        state: 1, // 1 获取成功 0 获取失败
        msg: '', // 提示信息
        data:  [
                {
                        sid: 1, // 分类ID
                        sortname: '', // 分类名称
                        alias: '', // 分类别名
                        description: '', // 描述
                        template: '', // 分类模版
                        lognum: 15, // 包含几篇文章
                        taxis: 5, // 排序序号
                        pid: 0, // 父类id
                        children: [ // 子分类
                                {
                                        sid: 1, // 分类ID
                                        sortname: '', // 分类名称
                                        alias: '', // 分类别名
                                        description: '', // 描述
                                        template: '', // 分类模版
                                        lognum: 15, // 包含几篇文章
                                        taxis: 5, // 排序序号
                                        pid: 0 // 父类id
                                }
                        ]
                }
        ]
}

获取文章附件

请求方式: GET

请求地址: attachment

请求参数:

blogid 文章ID

thumb 是否获取缩略图 1 获取 0 不获取

响应数据:

 

 

请在这里放置你的在线分享代码
广告位 后台主题配置管理

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

    此处不必修改,程序自动调用!
文章归档
站点信息
  • 文章总数:2512
  • 页面总数:8
  • 分类总数:45
  • 标签总数:385
  • 评论总数:699
  • 浏览总数:1735417
标签列表
最近发表
广告位 后台主题配置管理