Skip to content
页面梗概

助力生态可持续发展

赞助 Fresns 发展

成为赞助者

内容处理开发

涉及接口

帖子列表

接口路径描述命令字
/api/v2/post/list获取帖子列表getPostByAll
/api/v2/post/follow获取关注对象的帖子列表getPostByFollow
/api/v2/post/nearby获取位置附近的帖子列表getPostByNearby
  • 根据插件关联使用表 plugin_usages->data_sources 的配置,主程序会将请求通过命令字传输给插件,由插件处理客户端请求并返回结果。

帖子详情

接口路径描述命令字
/api/v2/post/detail获取帖子详情getPostDetail

搜索

接口路径描述命令字
/api/v2/search/users搜索用户searchUsers
/api/v2/search/groups搜索小组searchGroups
/api/v2/search/hashtags搜索话题searchHashtags
/api/v2/search/posts搜索帖子searchPosts
/api/v2/search/comments搜索评论searchComments

内容审核

接口路径描述命令字
/api/v2/editor/{type}/{draftId}

/api/v2/editor/direct-publish
内容发表reviewNotice

当内容触发审核时,会请求该命令字。

请求示例
php
$reviewService = ConfigHelper::fresnsConfigByItemKey('content_review_service');

$wordType = match ($type) {
    'post' => 1,
    'comment' => 2,
};

$wordBody = [
    'type' => $wordType,
    'logId' => $draft->id,
];

\FresnsCmdWord::plugin($reviewService)->reviewNotice($wordBody);

请求流程

参数类型是否必传说明
headersObjectYESAPI 的 Headers 参数
bodyObjectYES对应 API 的 Body 参数

请求示例:

php
$wordBody = [
    "headers" => \request()->headers->all(),
    "body" => $dtoRequest->toArray(),
];

\FresnsCmdWord::plugin($unikey)->getPostByFollow($wordBody)

\FresnsCmdWord::plugin($unikey)->getPostDetail($wordBody)

\FresnsCmdWord::plugin($unikey)->searchPosts($wordBody)

返回示例:

插件处理完毕并返回数据,主程序将直接把返回数据传输到主程序 API 接口。

  • 建议插件按照对应 API 的参数格式输出,保证不同客户端也能直接使用。
  • 如果你是自己定制的客户端,有特殊要求,那么插件也可以返回定制客户端要求的格式输出。

补充介绍

公开模式: site_mode=public

  • 未登录
    • 1、不输出非公开的小组帖子 groups->type_mode=2
    • 2、判断帖子是否有权限条件 posts->is_allow
      • 无权限条件,正常输出内容;有权限条件,则直接按权限配置输出内容(百分比、按钮文字和处理插件)。
      • 百分比 post_appends->allow_proportion
      • 按钮文字 post_appends->allow_btn_name
      • 处理插件 post_appends->allow_plugin_unikey
      • 参考 App\Fresns\Api\Services\PostService::contentHandle
  • 已登录
    • 1、不输出非公开的小组帖子 groups->type_mode=2,除非已经 user_follows 了该小组。
    • 2、过滤屏蔽对象的帖子 user_blocks->block_id
      • block_type=1 该用户发表的帖子
      • block_type=2 发表在该小组下的帖子
      • block_type=3 关联该话题的帖子
      • block_type=4 该帖子
    • 3、判断帖子是否有权限条件 posts->is_allow,逻辑同上

私有模式: site_mode=private

  • 未登录
    • 1、不输出帖子列表。
  • 已登录
    • 1、角色权限,是否有权浏览 roles->permission['content_view']
    • 2、用户 users->expired_at 是否在有效期内(为空代表永久有效)。
      • 2.1、site_private_end_after=1 过期后内容不可见,不输出帖子列表。
      • 2.2、site_private_end_after=2 过期后,到期前的内容可见,输出到期日期前的帖子列表。
      • 2.3、在有效期内,全部输出。
    • 其余逻辑同公开模式的已登录(非公开小组、屏蔽对象、帖子权限)。

内容输出解析逻辑(包括评论内容)

  • 内容输出的时候,需要解析并输出对应格式的内容(话题、链接、艾特、表情)。
    • 参考 App\Utilities\ContentUtility::handleAndReplaceAll
  • 内容输出还需替换过滤词。
    • 参考 App\Utilities\ContentUtility::replaceBlockWords