头像
平凡

bolg-api 开发文档

平凡
⋅
2019-02-22 14:36:45
⋅
161 阅读
⋅
Laravel
⋅
编辑

项目概述

该系统使用 Laravel5.6 编写而成。

功能如下

  • 文章列表 -- Elasticsearch搜索；
  • 文章详情；
  • 微信小程序评论、回复、收藏、点赞；
  • 通知 websocket 广播；
  • 用户认证 -- 后台登录、退出；
  • 多角色权限管理；
  • 附件上传 -- 支持清除无用的附件；
  • 文章管理 -- 列表、详情、发布、修改、删除；
  • 用户管理 -- 列表、添加、修改、分配角色；
  • 定时清除无用的附件；
  • Debugbar;

后台截图

文章列表

文章详情

文章发布

文章预览

运行环境要求

  • Nginx 1.8+
  • PHP 7.0+
  • MySQL 5.7+
  • Redis 3.0+
  • Elasticsearch 6.0+

开发环境部署/安装

本项目代码使用 PHP 框架 Laravel 5.6 开发，本地开发环境使用 Laravel Valet。

基础安装

1. 克隆源代码

克隆 blog-api 源代码到本地：

> git clone https://github.com/yanthink/blog-api.git

2. 安装扩展包依赖

$ composer install

3. 生成配置文件

$ cp .env.example .env

你可以根据情况修改 .env 文件里的内容，如数据库连接、缓存、邮件设置等：

APP_URL=http://api.blog.test
...
DB_HOST=localhost
DB_DATABASE=blog
DB_USERNAME=root
DB_PASSWORD=

4. 生成秘钥

$ php artisan key:generate

5. 生成 JWT_SECRET

$ php artisan jwt:secret

6. 创建软连接

$ php artisan storage:link

7. 生成数据表及生成测试数据

$ php artisan migrate --seed

初始的用户角色权限已使用数据迁移生成。

管理员账号密码如下:

username: admin
password: 888888

8. 安装elasticsearch

$ brew install elasticsearch

9. 安装elasticsearch-analysis-ik

$ cd $(brew --prefix elasticsearch)
$ ./bin/elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v6.2.4/elasticsearch-analysis-ik-6.2.4.zip

10. 初始化Elasticsearch

$ php artisan es:init

至此, 安装完成 ^_^。

扩展包使用情况

扩展包一句话描述本项目应用场景
dingo/api处理api接口的开源插件用于api接口
tymon/jwt-auth身份验证的软件包用于api认证
predis/predisRedis 官方首推的 PHP 客户端开发包缓存驱动 Redis 基础扩展包
zizaco/entrust角色权限管理角色和权限控制
zgldh/qiniu-laravel-storageQiniu 云储存 Laravel 5 Storage版存储附件
barryvdh/laravel-ide-helper代码提示及补全工具代码提示及补全
barryvdh/laravel-debugbar页面调试工具栏 (对 phpdebugbar 的封装)开发环境中的 DEBUG
overtrue/laravel-wechat微信 SDK for Laravel 5 / Lumen微信小程序登录

自定义 Artisan 命令

命令行名字说明Cron代码调用
remove-tmp-attachment删除临时附件每天凌晨2点执行一次无
es:init初始化elasticsearch无无
sync-article-read-count将Redis的文章阅读次数数据同步到数据库中每天凌晨0点执行一次无

队列清单

名称说明调用时机
SaveArticleAttachment.php保存临时附件发布文章和更新文章

小程序二维码

file

0 评论
暂无数据