vtgianni/apiplatformdoc-bundle

一个用于生成API Platform文档的Symfony包。

安装: 21

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:symfony-bundle

v0.1.8 2023-08-08 15:04 UTC

README

Logo

关于

Api Platform Doc Bundle是一个提供简单文档的Symfony包,如果您不想使用Swagger。

安装

需求

⚠️ 这里是使用Api Platform Doc Bundle的要求

php: >=7.4
api-platform/core: ^2.6
symfony/framework-bundle: >=5.4

开始使用

要开始使用Api Platform Doc Bundle,使用Composer将包添加到项目的依赖中

composer require vtgianni/apiplatformdoc-bundle

然后在config/packages/security.yaml文件中添加此服务

ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameResolverInterface: '@api_platform.route_name_resolver.cached'

并将此路由添加到config/routes.yaml文件中

api_platform_doc:
  resource: "@ApiPlatformDocBundle/Resources/config/routing.yaml"

最后在.env.local文件中配置所需的路由以查看文档

API_PLATFORM_DOC_PATH="documentation"

就这样!您应该能够在这个新路由中看到文档

https://127.0.0.1:8000/documentation