vtgianni / apiplatformdoc-bundle
一个用于生成API Platform文档的Symfony包。
v0.1.8
2023-08-08 15:04 UTC
Requires
- php: >=7.4
- api-platform/core: ^2.6
- symfony/framework-bundle: ^5.4
- dev-main
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- v0.1.0
- v0.0.41
- v0.0.40
- v0.0.39
- v0.0.38
- v0.0.37
- v0.0.36
- v0.0.35
- v0.0.34
- v0.0.33
- v0.0.32
- v0.0.31
- v0.0.30
- v0.0.29
- v0.0.28
- v0.0.27
- v0.0.26
- v0.0.25
- v0.0.24
- v0.0.23
- v0.0.22
- v0.0.21
- v0.0.20
- v0.0.19
- v0.0.18
- v0.0.17
- v0.0.16
- v0.0.15
- v0.0.14
- v0.0.13
- v0.0.12
- v0.0.11
- v0.0.10
- v0.0.9
- v0.0.8
- v0.0.7
- v0.0.6
- v0.0.5
- v0.0.4
- v0.0.3
- v0.0.2
- v0.0.1
This package is auto-updated.
Last update: 2024-09-08 17:47:36 UTC
README
关于
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
