README

自动将 CRUD 映射到定义模块中的 Presenters 和操作。并在 Presenter 中创建可访问的参数。

• 格式
• id (自动检测)
• 关联 (关联数组)
• 数据 (请求的原始数据)
• 查询 (查询字符串中的项目数组)

格式检测

变量 $format 从 HTTP 头部 Accept 中检测。如果头部不存在，Route 尝试从 URL 中检测格式（例如 .../foo.json）。如果 URL 中没有格式，Route 使用默认格式 json。

安装

安装 Nette-RestRoute 的最佳方式是使用 Composer

$ composer require adamstipak/nette-rest-route

使用方法

use AdamStipak\RestRoute;

// $router is an instance of Nette\Application\Routers\RouteList  

// No parameters needed. Presenter name will be generated.
$router[] = new RestRoute;

// With module.
$router[] = new RestRoute('Api');

// With module and xml as a default format.
$router[] = new RestRoute('Api', 'xml');

第一个参数是路由将发送请求的模块的名称。将生成 URL 前缀。请参阅示例。####示例

NULL      => /<generated presenter name>
'Api'     => /api/<generated presenter name>
'My:Api'  => /my/api/<generated presenter name>
...

第二个参数是默认格式。默认情况下，默认格式为 json。RestRoute 仅支持 2 种格式

• json (默认)
• xml

示例

读取所有

URL: /api/users → \ApiModule\UsersPresenter::actionReadAll
HTTP 头部 Accept: application/json
方法: GET
请求体: 空的
参数

format = json
associations = array(0)
data = ""
query = array(0)

标志 readAll 已被丢弃，如果没有在 URL 中找到资源 ID，Route 会自动生成操作 readAll。

按资源 ID 读取

URL: /api/users/123 → \ApiModule\UsersPresenter::actionRead
HTTP 头部 Accept: application/json
方法: GET
请求体: 空的
参数

format = json
id = 123
associations = array(0)
data = ""
query = array(0)

查询参数

URL: /api/users?foo=bar&page=1 → \ApiModule\UsersPresenter::actionRead
HTTP 头部 Accept: application/json
方法: GET
请求体: 空的
参数

format = json
associations = array(0)
data = ""
query = array(
	foo => "bar"
	page => 1
)

创建

URL: /api/users → \ApiModule\UsersPresenter::actionCreate
HTTP 头部 Accept: application/json
方法: POST
请求体

{
	"foo": "bar",
	"nested": {
		"foo": "bar"	
	}
}

参数

format = json
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

更新

URL: /api/users/123 → \ApiModule\UsersPresenter::actionUpdate
HTTP 头部 Accept: application/json
方法: PUT
请求体

{
	"foo": "bar",
	"nested": {
		"foo": "bar"	
	}
}

参数

format = json
id = 123
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

部分更新

URL: /api/users/123 → \ApiModule\UsersPresenter::actionPartialUpdate
HTTP 头部 Accept: application/json
方法: PATCH
请求体

{
	"foo": "bar",
	"nested": {
		"foo": "bar"	
	}
}

参数

format = json
id = 123
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

删除

URL: /api/users/123 → \ApiModule\UsersPresenter::actionDelete
HTTP 头部 Accept: application/json
方法: DELETE
请求体: 空的
参数

format = json
id = 123
associations = array(0)
data = ""
query = array(0)

选项

有关更多关于 OPTIONS 文档的信息，请参阅 w3.org。

URL: /api/users → \ApiModule\UsersPresenter::actionOptions
HTTP 头部 Accept: application/json
方法: OPTIONS
请求体: 空的
参数

format = json
associations = array(0)
data = ""
query = array(0)

关联

点号之前的最后一个项目（对）是主资源。点号之前的一切都是关联（apigee.com）。

URL: /api/users/1/comments → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP 头部 Accept: application/json
方法: GET, POST, PUT, DELETE
请求体: 空的
参数

format = json
associations = array(
	users => 1
)
data = ""
query = array(0)

URL: /api/users/123/comments/456 → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP 头部 Accept: application/json
方法: GET, POST, PUT, DELETE
请求体: 空的
参数

format = json
id = 456
associations = array(
	users => 123
)
data = ""
query = array(0)

URL: /api/users/1/blogs/2/comments → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP 头部 Accept: application/json
方法: GET, POST, PUT, DELETE
请求体: 空的
参数

format = json
id = 1
associations = array(
	users => 1
	blogs => 2
)
data = ""
query = array(0)

##覆盖方法 PUT, PATCH, DELETE

可以通过以下方式覆盖方法 PUT、PATCH 和 DELETE

HTTP 头部 X-HTTP-Method-Override

示例

X-HTTP-Method-Override: <PUT|PATCH|DELETE>

查询参数 __method

示例

?__method=<PUT|PATCH|DELETE>

##开发

RestRoute 通过 docker-compose 命令在 Docker 容器中开发。

示例

$ docker-compose run --rm default install  # install deps via composer
$ docker-compose run --rm default  # runs tests in container

连接到容器

$ docker-compose run --rm default bash # runs bash in container and attach tty