如何从 API 平台文档中隐藏路由 [英] How to hide a route from API Platform documentation

问题描述

我正在使用 Symfony4 下的 API 平台构建 API，

I'm building an API with API Platform under Symfony4,

我想在文档中隐藏一个实体，该实体仅可由打击的 ROLE_ADMIN 访问，而无需在文档中可见.

I want to hide an entity in the doc which is accessible only to the ROLE_ADMIN of the blow no interest to be visible in the doc.

这是我想隐藏的实体:

<?php

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiResource;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

/**
 * @ApiResource(
 *     attributes={"access_control"="is_granted('ROLE_ADMIN')"}
 * )
 * @ORM\Entity(repositoryClass="App\Repository\OrderStatusRepository")
 */
class OrderStatus
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     * @Groups("orderGET")
     */
    private $label;

    /**
     * @return int|null
     */
    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * @return null|string
     */
    public function getLabel(): ?string
    {
        return $this->label;
    }

    /**
     * @param string $label
     * @return OrderStatus
     */
    public function setLabel(string $label): self
    {
        $this->label = $label;

        return $this;
    }
}

感谢您的帮助

推荐答案

这不是开箱即用的支持(但它会是一个很好的贡献).您可以做的是将 DocumentationNormalizer 修饰为 unset() 不想出现在 OpenAPI 文档中的路径.

This isn't supported out of the box (but it would be a nice contribution). What you can do is to decorate the DocumentationNormalizer to unset() the paths you don't want to appear in the OpenAPI documentation.

有关在 API 平台中覆盖规范的更多信息OpenAPI 文档

这篇关于如何从 API 平台文档中隐藏路由的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！