如何从 Nelmio Docs 中隐藏 Api-platform Docs

Question

我希望有人可以帮助我将 Api 平台与 Nelmio 一起使用。

我使用 Api 平台和 Nelmio。我需要对 Nelmio 隐藏 Api 平台文档。

我需要 3 条路线：

/internal -> API-Platform Docs
/external -> NELMIO-Docs
/admin -> NELMIO-Docs

我的 Nelmio 配置：

# config/packages/nelmio_api_doc.yaml
nelmio_api_doc:
    documentation:
        info:
            title: ...
            description: ...
            version: 0.2.0
    areas: # to filter documented areas
        default:
            path_patterns: [ ^/external ]
        external:
            path_patterns: [ ^/external ]
        admin:
            path_patterns: [ ^/admin ]

我的 Nelmio 配置（路由）：

# config/routes/nelmio_api_doc.yaml
app.swagger:
    path: /{area}/json
    methods: GET
    defaults: { _controller: nelmio_api_doc.controller.swagger, area: default }

app.swagger_ui:
    path: /{area}
    methods: GET
    defaults: { _controller: nelmio_api_doc.controller.swagger_ui, area: default }

我的 API 平台配置：

# config/routes/api_platform.yaml
api_platform:
    resource: .
    type: api_platform
    prefix: /internal/

但是如果我去http://localhost/external 或http://localhost/admin 我总是看到不仅需要的路线，还有来自API-Platform的路线：

Answer 1

我知道这个问题现在已经过时了，但我面临同样的情况，我找到了一种可能对某些人有帮助的解决方法，所以我发布了它。

API 平台允许您装饰 Swagger，以便您可以自定义最终文档输出。我利用这一点在不要求时摆脱了整个 api 平台文档。

<?php

namespace App\Swagger;

use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

final class SwaggerDecorator implements NormalizerInterface
{
    private $decorated;
    private $requestStack;

    public function __construct(NormalizerInterface $decorated, RequestStack $requestStack)
    {
        $this->decorated = $decorated;
        $this->requestStack = $requestStack;
    }

    public function normalize($object, $format = null, array $context = [])
    {
        if ('/internal/docs' !== $this->requestStack->getCurrentRequest()->getPathInfo()) {
            // request is not for internal docs (maybe it is for external or admin one) so get rid of api platform docs
            return null;
        }

        $docs = $this->decorated->normalize($object, $format, $context);

        // here you can customize documentation

        return $docs;
    }

    public function supportsNormalization($data, $format = null)
    {
        return $this->decorated->supportsNormalization($data, $format);
    }
}

我希望这对某人有所帮助，编码愉快！

---

更新

为了启用该装饰器，您必须在您的服务文件中声明它：

App\Swagger\SwaggerDecorator:
        decorates: 'api_platform.swagger.normalizer.api_gateway'
        arguments: [ '@App\Swagger\SwaggerDecorator.inner' ]
        autoconfigure: false

然后，在类本身中，将 '/internal/docs' 替换为您用于 API 平台文档的实际 URL。

希望这会有所帮助。

Answer 2

在您的 nelmio 配置 yaml 文件中，使用正则表达式排除文档。例如，要排除/external/doc，您应该：

 external:
            path_patterns: [ ^/external(?!/doc$) ]