insidion/swagger-bundle

此包已被弃用,不再维护。未建议替代包。

生成 Swagger 文档

安装: 381

依赖: 1

建议者: 0

安全: 0

星标: 2

关注者: 7

分支: 3

开放问题: 0

语言:JavaScript

类型:symfony-bundle

2.0.0-alpha4 2018-02-22 23:25 UTC

This package is auto-updated.

Last update: 2024-02-05 17:10:20 UTC


README

将 swagger.io 的强大功能集成到您的 Symfony 3 应用程序中。

如果您还没有听说过 swagger,我建议您去看看。它定义了您的 REST API 服务的合同。它还提供了一个内置的 Web 界面,可以执行带有提供的示例模型的请求。

然而,自己编写可能会变得繁琐,因此我引入了这个包!

特性

  • 基于注解的 REST API 定义 - 使您的代码具有自文档性
  • 集成了 Swagger UI。访问 <your_site>/swagger/ 使用它。 - 使测试更简单。
  • 生成的定义完全符合 Swagger 标准
  • 只在启动时生成您的 swagger.json - 缓存(默认启用)

待实现

我目前计划在未来实现以下功能

  • 安全设置
  • FOSRestBundle 版本集成

有其他建议?请发送电子邮件至 mitchellherrijgers@gmail.com

更多文档

我不会让您陷入黑暗中自己去弄清楚这个包是如何工作的。您可以在 Resources/doc 文件夹中找到文档。