Drupal 8 restresource:找不到路线
Drupal 8 restresource: No route found
我正在尝试创建一个休息端点。我这样做的方法是首先使用 drupal generate:module
创建一个模块,然后添加其余依赖项,然后使用 drupal generate:plugin:rest:resource
创建一个 restresource。这一切工作正常,我创建的端点甚至显示在模块 restui 中,路径如下:/api/v1/articles
。
问题是当我转到我创建的端点时出现以下错误:
{
"message": "No route found for \"GET /api/v1/articles\""
}
缓存重建无法解决我的问题,当我查看路由 table 时,确实没有为 /api/v1/articles
添加路由。
有什么我忘记做的事吗?
这是生成的休息资源:
namespace Drupal\api_articles\Plugin\rest\resource;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\rest\Plugin\ResourceBase;
use Drupal\rest\ResourceResponse;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Psr\Log\LoggerInterface;
/**
* Provides a resource to get view modes by entity and bundle.
*
* @RestResource(
* id = "article_rest_resource",
* label = @Translation("Article rest resource"),
* uri_paths = {
* "canonical" = "/api/v1/articles",
* "https://www.drupal.org/link-relations/create" = "/api/v1/articles"
* }
* )
*/
class ArticleRestResource extends ResourceBase {
/**
* A current user instance.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* Constructs a Drupal\rest\Plugin\ResourceBase object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param array $serializer_formats
* The available serialization formats.
* @param \Psr\Log\LoggerInterface $logger
* A logger instance.
* @param \Drupal\Core\Session\AccountProxyInterface $current_user
* A current user instance.
*/
public function __construct(
array $configuration,
$plugin_id,
$plugin_definition,
array $serializer_formats,
LoggerInterface $logger,
AccountProxyInterface $current_user) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
$configuration,
$plugin_id,
$plugin_definition,
$container->getParameter('serializer.formats'),
$container->get('logger.factory')->get('api_articles'),
$container->get('current_user')
);
}
/**
* Responds to GET requests.
*
* Returns a list of bundles for specified entity.
*
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
* Throws exception expected.
*/
public function get() {
// You must to implement the logic of your REST Resource here.
// Use current user after pass authentication to validate access.
if (!$this->currentUser->hasPermission('access content')) {
throw new AccessDeniedHttpException();
}
return new ResourceResponse("Implement REST State GET!");
}
}
所以问题出在从 8.1.9 升级到 8.2.0 时。这破坏了我用来分配端点的 RestUI 模块。
问题是 restui 不会为您的资源创建配置文件,如果您只想使用稳定版本 (8.x-1.12),您可以自己创建它。 restui 的开发版本已经修复了这个问题。
根据REST and Application Integration:
The content type for the data you send, or the accept type for the
data you are receiving, must be set to 'application/hal+json'.
所以需要进行以下步骤:
- 启用 HAL 模块。
- 在资源配置中,在 Accepted request formats 下启用 hal_json.
- [I]nform Drupal about the serialization format you are using。因此,要么使用 hal+json(例如 POST)发送 Content-Type header,要么将
?_format=hal+json
添加到 URL(例如 GET)。
这也可能是由于 @RestResource
注释中缺少这一行造成的,但您已经有了它:
"https://www.drupal.org/link-relations/create" = "/api/v1/articles"
我正在尝试创建一个休息端点。我这样做的方法是首先使用 drupal generate:module
创建一个模块,然后添加其余依赖项,然后使用 drupal generate:plugin:rest:resource
创建一个 restresource。这一切工作正常,我创建的端点甚至显示在模块 restui 中,路径如下:/api/v1/articles
。
问题是当我转到我创建的端点时出现以下错误:
{
"message": "No route found for \"GET /api/v1/articles\""
}
缓存重建无法解决我的问题,当我查看路由 table 时,确实没有为 /api/v1/articles
添加路由。
有什么我忘记做的事吗?
这是生成的休息资源:
namespace Drupal\api_articles\Plugin\rest\resource;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\rest\Plugin\ResourceBase;
use Drupal\rest\ResourceResponse;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Psr\Log\LoggerInterface;
/**
* Provides a resource to get view modes by entity and bundle.
*
* @RestResource(
* id = "article_rest_resource",
* label = @Translation("Article rest resource"),
* uri_paths = {
* "canonical" = "/api/v1/articles",
* "https://www.drupal.org/link-relations/create" = "/api/v1/articles"
* }
* )
*/
class ArticleRestResource extends ResourceBase {
/**
* A current user instance.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* Constructs a Drupal\rest\Plugin\ResourceBase object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param array $serializer_formats
* The available serialization formats.
* @param \Psr\Log\LoggerInterface $logger
* A logger instance.
* @param \Drupal\Core\Session\AccountProxyInterface $current_user
* A current user instance.
*/
public function __construct(
array $configuration,
$plugin_id,
$plugin_definition,
array $serializer_formats,
LoggerInterface $logger,
AccountProxyInterface $current_user) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
$configuration,
$plugin_id,
$plugin_definition,
$container->getParameter('serializer.formats'),
$container->get('logger.factory')->get('api_articles'),
$container->get('current_user')
);
}
/**
* Responds to GET requests.
*
* Returns a list of bundles for specified entity.
*
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
* Throws exception expected.
*/
public function get() {
// You must to implement the logic of your REST Resource here.
// Use current user after pass authentication to validate access.
if (!$this->currentUser->hasPermission('access content')) {
throw new AccessDeniedHttpException();
}
return new ResourceResponse("Implement REST State GET!");
}
}
所以问题出在从 8.1.9 升级到 8.2.0 时。这破坏了我用来分配端点的 RestUI 模块。
问题是 restui 不会为您的资源创建配置文件,如果您只想使用稳定版本 (8.x-1.12),您可以自己创建它。 restui 的开发版本已经修复了这个问题。
根据REST and Application Integration:
The content type for the data you send, or the accept type for the data you are receiving, must be set to 'application/hal+json'.
所以需要进行以下步骤:
- 启用 HAL 模块。
- 在资源配置中,在 Accepted request formats 下启用 hal_json.
- [I]nform Drupal about the serialization format you are using。因此,要么使用 hal+json(例如 POST)发送 Content-Type header,要么将
?_format=hal+json
添加到 URL(例如 GET)。
这也可能是由于 @RestResource
注释中缺少这一行造成的,但您已经有了它:
"https://www.drupal.org/link-relations/create" = "/api/v1/articles"