Flarum APIs 使用帮助以及文档。

卖掉内裤去上网

因为Flarum简单，开放，自由，于是乎毫不犹豫的入坑了，虽然还是beta版本，以至于正式版都不知道什么时候放出来，也不知道APIs 是否会变更，但是还是毫不犹豫来研究APIs 是如何工作的。

根绝官方文档APIs大概分为以下接口：（若需要授权access_token我会注明）。

| 接口 | 是否需要access_token | method | 参数 | 说明 |
| ---- | ---- | ---- | ---- | ---- |
|/api/token| 否 | POST | identification, password| 获取access_token |
|/api/forum | 否 | GET | 无 | 获取论坛基本信息，包括所有的tags/groups/usersGroups等信息|
|/api/forum | 是 | PATCH | 参见附录1 | 更新论坛配置 |

| 接口 | /api/token |
| --- | --- |
|method | GET |
|参数 | identification, password |
| 返回值 | token ， id |

参数说明：

| 参数 | 默认值 | 类型 | 说明 |
| --- | --- | --- | --- |
| identification | 无 | string | 允许使用email,和username |
| password | 无 | stirng | 用户密码 |

如下：

{
  "identification": "卖掉内裤去上网",
  "password": "xxxxxxxx"
}

xueyou

好奇表格没渲染出来

卖掉内裤去上网

xueyou
对哦果然 Markdown 语法的table 是有问题的

卖掉内裤去上网

@卖掉内裤去上网#560

不知道Farum是否支持 Markdown 的table 操作，如果不行大家就姑且这样看看吧

根绝官方文档APIs大概分为以下接口：（若需要授权access_token我会注明）。

| 接口 | /api/token |
| --- | --- |
|method | GET |
|参数 | identification, password |
| 返回值 | token ， id |

参数说明：

| 参数 | 默认值 | 类型 | 说明 |
| --- | --- | --- | --- |
| identification | 无 | string | 允许使用email,和username |
| password | 无 | stirng | 用户密码 |

如下：

{
  "identification": "卖掉内裤去上网",
  "password": "xxxxxxxx"
}

返回结果说明：

{
    "token": "xxxxxxxxxxxxxx",
    "userId": "137"
}

注：token 是有过期时间一说的，如果token过期，基本上会返回 http 500的错误（我就在这里入坑了）
有了token 你就可以进行后续操作了。

编辑时间过期了我只能用回帖来操作了

@justjavac 有时间帮忙整理一下咯。

卖掉内裤去上网

| 接口 | /api/forum |
| --- | --- |
| method | GET |
| 参数 | 无|
| 返回值| 见下 |

此接口，目前来说无任何参数，不知filter[groups]参数是我研究有问题还是本身代码不起作用

返回值：

{
    "data": {
        "type": "forums",
        "id": "1",
        "attributes": {
            "title": "Flarum 中文开发者社区",
            "description": "Flarum 是一个优雅的轻论坛软件，简约界面回归社区本质。这里没有太多的条条框框规定，在这里你可以谈天说地，可以在最短的时间收集灵感，寻找有趣的东西。",
            "baseUrl": "http://discuss.flarum.org.cn",
            "basePath": "",
            "debug": false,
            "apiUrl": "http://discuss.flarum.org.cn/api",
            "welcomeTitle": "欢迎访问 Flarum 中文开发者社区",
            "welcomeMessage": "Flarum 是一个优雅的轻论坛软件，简约界面回归社区本质。这里没有太多的条条框框规定，在这里你可以谈天说地，可以在最短的时间收集灵感，寻找有趣的东西。",
            "themePrimaryColor": "#4D698E",
            "canView": true,
            "canStartDiscussion": false,
            "allowSignUp": true,
            "defaultRoute": "/all",
            "minPrimaryTags": "1",
            "maxPrimaryTags": "1",
            "minSecondaryTags": "0",
            "maxSecondaryTags": "3"
        },
        "relationships": {
            "groups": {
                "data": [
                    {
                        "type": "groups",
                        "id": "1"
                    },
                
                ]
            },
            "tags": {
                "data": [
                    {
                        "type": "tags",
                        "id": "1"
                    },
                   
                ]
            }
        }
    },
    "included": [
        {
            "type": "groups",
            "id": "1",
            "attributes": {
                "nameSingular": "Admin",
                "namePlural": "Admins",
                "color": "#B72A2A",
                "icon": "wrench"
            }
        },
      
        {
            "type": "tags",
            "id": "3",
            "attributes": {
                "name": "需求",
                "description": "需要一些额外的功能，包括插件、扩展、语言包",
                "slug": "features",
                "color": "#E2C783",
                "backgroundUrl": null,
                "backgroundMode": null,
                "iconUrl": null,
                "discussionsCount": 2,
                "position": 7,
                "defaultSort": null,
                "isChild": false,
                "isHidden": false,
                "lastTime": "2015-09-26T15:47:02+08:00",
                "canStartDiscussion": true
            },
            "relationships": {
                "lastDiscussion": {
                    "data": {
                        "type": "discussions",
                        "id": "110"
                    }
                }
            }
        },
        {
            "type": "tags",
            "id": "4",
            "attributes": {
                "name": "UX",
                "description": "关于Flarum的用户体验和界面设计",
                "slug": "ux",
                "color": "#92E6D9",
                "backgroundUrl": null,
                "backgroundMode": null,
                "iconUrl": null,
                "discussionsCount": 0,
                "position": 3,
                "defaultSort": null,
                "isChild": false,
                "isHidden": false,
                "lastTime": null,
                "canStartDiscussion": true
            }
        },
        {
            "type": "tags",
            "id": "5",
            "attributes": {
                "name": "插件扩展",
                "description": "开发或者讨论扩展",
                "slug": "extensions",
                "color": "#9ACEC7",
                "backgroundUrl": null,
                "backgroundMode": null,
                "iconUrl": null,
                "discussionsCount": 18,
                "position": 4,
                "defaultSort": null,
                "isChild": false,
                "isHidden": false,
                "lastTime": "2015-10-02T18:10:54+08:00",
                "canStartDiscussion": true
            },
            "relationships": {
                "lastDiscussion": {
                    "data": {
                        "type": "discussions",
                        "id": "47"
                    }
                }
            }
        },
      
    ]
}

| 接口 | /api/forum |
| --- | --- |
| method | GET |
| 参数 | 见下|
| 返回值| 同上|

注：本接口需要设置access_token 放在header中如

Authorization: Token your_access_token
并且需要设置 Content-type: application/vnd.api+json
注：Flarum的APIs有一个小小的BUG，Content-type设置只需要包含 json 这个字符串均可以通过

参数：

{
    "data": {
        "attributes": {
            "title": "Flarum 中文开发者社区",
            "description": "Flarum 是一个优雅的轻论坛软件，简约界面回归社区本质。这里没有太多的条条框框规定，在这里你可以谈天说地，可以在最短的时间收集灵感，寻找有趣的东西。",
            "baseUrl": "http://discuss.flarum.org.cn",
            "basePath": "",
            "debug": false,
            "apiUrl": "http://discuss.flarum.org.cn/api",
            "welcomeTitle": "欢迎访问 Flarum 中文开发者社区",
            "welcomeMessage": "Flarum 是一个优雅的轻论坛软件，简约界面回归社区本质。这里没有太多的条条框框规定，在这里你可以谈天说地，可以在最短的时间收集灵感，寻找有趣的东西。",
            "themePrimaryColor": "#4D698E",
            "canView": true,
            "canStartDiscussion": false,
            "allowSignUp": true,
            "defaultRoute": "/all",
            "minPrimaryTags": "1",
            "maxPrimaryTags": "1",
            "minSecondaryTags": "0",
            "maxSecondaryTags": "3"
        }
}

我就不做坏事啦，你们可以通过api来更改论坛名称等信息

justjavac

谢谢你为flarum所做的，随后我会整理的。

卖掉内裤去上网

获取讨论

| 接口 | /api/discussions |
| --- | --- |
| method | GET|
| 参数 | page, filter |

参数说明：

| 字段 | 说明 | 默认值 | 是否必填 |
| --- | --- | --- | --- |
| page | 翻页| limit=20,offset=0 | 否 |

page参数说明

翻页请使用如下个格式提交：

page[limit], page[offset]

justjavac

Flarum的编辑器不支持 markdown 的扩展语法