dolphin836/slim-restful-api

基于 Slim 框架的 RESTful API 脚手架。

1.0.0 2017-06-26 08:50 UTC

README

Slim-RESTful-API 是基于 Slim Framework 的 RESTful API 脚手架。其主体框架来源于我 2017 年开发的一个商业项目。如果你还不了解 Slim Framework,可以从其 官网中文网站 了解相关信息。和 Laravel、Yii 等全能型框架相比,Micro Framework 拥有更好的性能和更大的灵活性。

Slim-RESTful-API 使用 Medoo 作为 MYSQL 数据库中间件。默认使用 JWT 做身份验证。

另外,还使用了 PHP dotenv 解析配置文件。

安装方法

使用 Composer 快速创建项目

composer create-project dolphin836/slim-restful-api [slim-app]

使用方法

配置 WEB 服务器

详细的配置方法请阅读 Slim Documentation Web Servers

初始化配置文件

将 .env.example 重命名为 .env,然后填写相应的信息。

DB_SERVERER="localhost" # 数据库服务器
DB_USERNAME="root"      # 数据用户名
DB_PASSWORD=""          # 数据库用户密码
DB_DATANAME=""          # 数据吗名称
ADMIN_USERNAME=""       # 管理员昵称
ADMIN_PHONE=""          # 管理员电话号码
ADMIN_PASSWORD=""       # 管理员密码
JWT_SECRET=""           # JWT 身份验证的密钥

初始化

运行程序初始化命令,安装程序会首先创建一张 user 表,然后使用 .env 中配置的管理员信息插入一条用户数据。

php install.php

添加路由

详细的路由规则请阅读 Slim Documentation Router

在 core/routes.php 中已经存在了一个简单的例子供你参考。

TODO

  • 微信和支付宝中间件
  • 完善介绍,标准化
  • 测试用例
  • 持续集成
  • 自动文档