README

一个简单的API，模拟了CMS的一些功能。

技术

• PHP
• MySQL
• Composer
• 库
  • Bramus-Router
  • PHP-JWT

安装

- composer require kteixeira/simple-cms-api dev-master (即将推出)

• Composer

  • 如果没有，请参阅 官方文档 了解如何安装

• 说明

  • 在本地克隆项目
  • 运行命令 composer install
  • 在 /configs 目录下创建一个名为 database.php 的文件，有一个模板可以参考，名为 database_example.php。请用您的MySQL连接信息填写。
  • 使用命令：php -S localhost:8080 (或您选择的端口) 启动测试服务器。
  • 首先进行身份验证，然后在headers中插入收到的 access_token。

注意

• 项目根目录下有一个名为 dump_cms.sql 的文件，它是一个SQL脚本，用于创建Schema和表，并已用测试应用填充。

API

创建帖子

• URL

  • /posts

• 方法

  • POST

• 必需的URL参数：[标题，路径]

• 正文

  • {"post":{"title":"Lorem Ipsum","body":"Lorem Ipsum","path":"/path/test"}}

• 成功响应

  • 代码：201
  • 内容：{"post":{"id":1,"title":"Lorem Ipsum","body":"Lorem Ipsum","path":"/path/test","created_at":"2017-11-30 00:04:47","updated_at":"2017-11-30 00:04:47"}}

更新帖子

• URL

  • /posts/:id

• 方法

  • PUT

• 正文

  • {"post":{"title":"Lorem Ipsum", "body":"Lorem Ipsum Updated", "path":"/path/test"}}

• 成功响应

  • 代码：200
  • 内容：{"post":{"id":1,"title":"Lorem Ipsum","body":"Lorem Ipsum Updated","path":"/path/test","updated_at":"2017-11-30 00:10:17"}}

获取帖子

• URL

  • /posts/:id

• 方法

  • GET

• 成功响应

  • 代码：200
  • 内容：[{"id":"1","title":"Lorem Ipsum","body":"Mel assum dicant intellegat et.","path":"/path/test","created_at":"2017-11-29 23:13:47","updated_at":"2017-11-29 23:32:58"}]

获取帖子列表

• URL

  • /posts

• 方法

  • GET

• 成功响应

  • 代码：200
  • 内容：[{"id":"1","title":"Lorem Ipsum","body":"Mel assum dicant intellegat et.","path":"/path/test","created_at":"2017-11-29 23:13:47","updated_at":"2017-11-29 23:32:58"}, {"id":"1","title":"Lorem Ipsum","body":"Mel assum dicant intellegat et.","path":"/path/test","created_at":"2017-11-29 23:13:47","updated_at":"2017-11-29 23:32:58"}, {"id":"1","title":"Lorem Ipsum","body":"Mel assum dicant intellegat et.","path":"/path/test","created_at":"2017-11-29 23:13:47","updated_at":"2017-11-29 23:32:58"}]

删除帖子

• URL

  • /posts/:id

• 方法

  • DELETE

• 成功响应

  • 代码：200
  • 内容：{"message":"Success"}

身份验证应用

• URL

  • /auth

• 方法

  • POST

• 必需的URL参数：[名称，密码]

• 正文（已经是数据库中注册的用户数据）

  • {"name": "App Teste","password": "teste1234"}

• 成功响应

  • 代码：200
  • 内容：{"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1MTIwMDgwNTEsImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdCIsImV4cCI6IjE1MTIwMTE2NDkiLCJuYmYiOjE1MTIwMDgwNTAsImRhdGEiOnsiaWQiOiIxIiwibmFtZSI6IkFwcCBUZXN0ZSIsImtleSI6IlhqWlVDbjlMdnhURiJ9fQ.TzDBAyi_bRmhYhn7lSFQ3CGNfetf-p5zR14gnf_AIDo"}