从API平台Swagger/OpenAPI留档输出中删除一些模式/模型

Question

API-Platform将为Schemas（AKA模型）生成Swagger/OpenAPI路由留档，然后在留档下方（文档将它们显示为“模型”，但当前版本（如2.7）将它们显示为“模式”）。

为显示这些模式/模型而生成的内容在哪里？如何删除一些？显示它们的功能是Swagger UI的一部分，但API平台必须负责提供JSON配置，从而更改API平台而不是Swagger UI。注意，这篇文章展示了如何添加模式，但没有展示如何删除模式。除此之外，是否有其他没有详细说明的文档？

正如下面的输出所示，我正在公开抽象组织（AbstractOrganization），然而，这个类被其他几个类扩展了，并不打算公开，只应该公开具体类的模式。请注意，我的AbstractOrganization实体类没有使用ApiResource标记，也没有显示在Swagger/OpenAPI路由文档中，而只显示在模式/模型文档中。

谢谢你

Answer 1

我很确定有更好的方法来实现这一点，但是，以下内容将起作用，可能对其他人有所帮助。

<?php
declare(strict_types=1);
namespace App\OpenApi;

use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\Core\OpenApi\OpenApi;
use ApiPlatform\Core\OpenApi\Model\Paths;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

class OpenApiRouteHider implements OpenApiFactoryInterface {

    public function __construct(private OpenApiFactoryInterface $decorated, private TokenStorageInterface $tokenStorage)
    {
    }

    public function __invoke(array $context = []): OpenApi 
    {
        $openApi = $this->decorated->__invoke($context);

        $removedPaths = $this->getRemovedPaths();

        $paths = new Paths;
        $pathArray = $openApi->getPaths()->getPaths();
        foreach($openApi->getPaths()->getPaths() as $path=>$pathItem) {
            if(!isset($removedPaths[$path])) {
                // No restrictions
                $paths->addPath($path, $pathItem);
            }
            elseif($removedPaths[$path]!=='*') {
                // Remove one or more operation
                foreach($removedPaths[$path] as $operation) {
                    $method = 'with'.ucFirst($operation);
                    $pathItem = $pathItem->$method(null);                    
                }
                $paths->addPath($path, $pathItem);
            }
            // else don't add this route to the documentation
        }
        $openApiTest = $openApi->withPaths($paths);

        return $openApi->withPaths($paths);
    }

    private function getRemovedPaths():array
    {
        // Use $user to determine which ones to remove.
        $user = $this->tokenStorage->getToken()->getUser();
        return [
            '/guids'=>'*',                  // Remove all operations
            '/guids/{guid}'=>'*',           // Remove all operations
            '/tenants'=>['post', 'get'],   // Remove only post and get operations
            '/tenants/{uuid}'=>['delete'], // Remove only delete operation
            '/chart_themes'=>'*',
            '/chart_themes/{id}'=>['put', 'delete', 'patch'],
        ];
    }
}