通过 
搜索
搜索phpsocialnetwork / insidion-swagger-acme-bundle
此包已被弃用且不再维护。未建议替代包。
Swagger Acme Bundle
dev-master
2018-02-25 10:46 UTC
Requires
- php: >= 5.6
- doctrine/annotations: ^1.4
- insidion/swagger-bundle: ^2.0
- sensio/framework-extra-bundle: ^5.1
- symfony/filesystem: ^3.3
- symfony/framework-bundle: ^3.3
- symfony/routing: ^3.3
This package is auto-updated.
Last update: 2024-02-05 18:15:06 UTC
README
⚠️ V2 目前处于开发中，尚未准备用于生产使用 ⚠️
你为什么需要这个包？
你需要它，因为它将 swagger.io 的强大功能集成到你的 Symfony 3 应用程序中。
如果你还没有听说过 Swagger，我们建议你看看它。它定义了你的 REST API 的服务合同。
为什么我应该为我的 Symfony REST API 定义服务合同？
- 你不爱完美无瑕且文档齐全的工作吗？
- 你不讨厌编写冗余的 PDF/Excel 来解释所有的 REST API 端点吗？
- 你不希望边写代码边编写文档吗？
试试看，你不会失望的！
你的包提供了什么具体的功能？
它提供了一套内置的、美观的 Web 界面来执行提供的示例模型中的 REST 请求。
内置的 Web 界面允许你使用自定义的头部/参数/cookies 测试大多数 HTTP REST 方法（DELETE、PATCH 等）。
自己编写可能会变得繁琐，因此我们引入了这个包！
当前功能
- 基于注解的 REST API 定义 - 使你的代码自动生成文档
- 集成的 Swagger UI
- 访问 <你的网站>/swagger/ 来使用它
- 你可以通过查看 Resources/doc 文件夹来自定义路由
- 使测试更容易。
- 通过配置缓存，在启动时仅生成 swagger.json
- 该包还支持用于处理缓存的自定义 Psr6 缓存服务
- 生成的定义完全符合 Swagger 标准
- 安全设置
- 标签定义
- 弃用突出显示
- 路由和参数定义的摘要/描述
- 为更好的合同规范定义模型
更多文档
我们不会让你在黑暗中摸索这个包是如何工作的。
你可以在 Resources/doc 文件夹中找到文档。
帮助/贡献
发现了问题？ 请随意报告。
有改进你体验的想法？ 发送我们一个 pull request。
有反馈吗？给我们发消息，非常欢迎！我们很乐意听到您的声音！
感谢您尝试使用我们💙