问题标签 [nelmioapidocbundle]

Is it possible to consolidate these two annotations so that I write it in single place?

我使用 NelmioApiDocBundle 和 Swagger 来描述我的 API。

我想描述包含另一个对象的响应对象：

例如 - json str：

我的 PHP 看起来像：

配置：

• php：“7.1.7”
• nelmio/api-doc-bundle：“3.0”
• symfony/symfony: "3.4.0",
• zircote/swagger-php": "2.0"

我正在使用 Nelmio Api Doc Bundle v3 开发 Symfony 4 API REST 应用程序。

我正在发送此请求：

这是响应正文：

我完全不知道为什么我发送强制注册=假而我的回复是“mandatory_registration”：真。

我在下面粘贴了我的控制器、表单、实体代码。以及 nelmio api doc 和 fos_rest 配置代码。

控制器 ：

事件类型形式：

事件类型实体：

配置：

在使用 Symfony 4 构建的项目中，我们使用 NelmioApiDocBundle 版本 3 加上 Swagger 注释，效果很好。

除了浏览 API 文档之外，我还想创建文档的静态版本，以在构建管道中生成。（在您的情况下，它是 Bitbucket Pipelines，但这不应该有所作为。） NelmioApiDocBundle 版本 2 具有用于发出文档的命令，但似乎版本 3 不再具有。编写一个从 Symfony 容器中获取的命令很容易ApiDocGenerator，从而获得我想要的信息——但我无法想象我是唯一一个希望这样做的人。

我忽略了什么吗？NelmioApiDocBundle 真的没有生成静态、离线文档的内置方法吗？

我正在尝试将 NelmioApiDocBundle 用于 Symfony 3.4 项目 API 文档，同时还试图围绕 OAuth 2 授权来开始项目 API 访问。

到目前为止，我已经按照本教程了解如何让 FOSOAuthServerBundle 工作。到目前为止，我可以 1.) 使用命令行命令创建客户端：

php bin/console fos:oauth-server:create-client --redirect-uri="___" --grant-type="authorization_code" --grant-type="password" --grant-type="refresh_token" - -grant-type="token" --grant-type="client_credentials"

2.) 我也可以通过在我的服务器上访问这个 url 来手动获取访问令牌

http://127.0.0.1:8000/oauth/v2/token?client_id=______&client_secret=________&grant_type=client_credentials

3.) 我可以使用令牌访问我的 Symfony 项目中需要 OAuth 访问的区域，方法是在 GET 参数中包含令牌

但是，在 NelmioApiDocBundle Authorizations 中，我无法完成这项工作。这是一个屏幕截图：

如果输入我的 client_id 和密钥，它会按预期将我带到登录页面。我可以输入我的登录信息并按预期将我带到批准或拒绝页面。此时，如果我单击 Approve 或 Deny，它会尝试使用http://localhost:3200/oauth2-redirect.html的“redirect_uri” 。无论我做什么，我都无法更改重定向 URI。

如何获得正确的重定向 URI？

我想为我的 Restful API 构建一个带有 swagger 的 UI 文档。这是该https://symfony.com/doc/master/bundles/NelmioApiDocBundle/index.html的官方文档， 但我收到了这个错误Unrecognized option "areas" under "nelmio_api_doc"

有什么建议么？

我们可以覆盖模型访问器属性名称或忽略它吗？

这是我的User::getUsername函数，它是电子邮件属性的吸气剂（我需要这样命名的函数来实现接口）：

并且生成的文档仍然显示：

你能帮我吗？

我正在开发一个Symfony 3.4 API。我想使用nelmioApiDocBundle v3.2为 API 生成文档，但我遇到了一些障碍。对于序列化和规范化，我使用 Symfony 序列化器，但在使用@SWG\Model注释时，我无法让 nelmioApiDocBundle 使用为 Symfony 序列化器配置的规范化器和名称转换器。

具体来说，我使用的是serializer.name_converter.camel_case_to_snake_case和DateTimeNormalizer

我也在使用FosRestBundle v2.0

这是我的配置：

控制器：

和formType：

请注意，我在日期属性的表单类中添加了“文档”选项，但我希望它由规范器处理。

这是 Swagger.ui 中的输出

提前致谢。

我想使用 NelmioApiDocBundle 自动生成文档。我使用标准 Symfony 文档来安装和配置它：https ://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html 。不幸的是，当我转到 /api/doc 时，我的文档是空的。

我在 v. 3.2.0 中使用 Symfony 3.4 和 NelmioApiDocBundle。

这是我的配置：

和我的控制器中的注释（一开始我想在我的文档中查看任何数据）：

在 /api/doc 中，我看到“规范中未定义任何操作！”。我究竟做错了什么？

@更新

我刚开始使用 Sami：http ://symfony.com/projects/sami

我想在 Symfony "v3.4.11" 和 nelmio/api-doc-bundle "v3.2.1" 上禁用 NelmioApiDocs 的沙盒模式

我试过了：

之后，我清除了 prod 和 dev 的缓存。但它不起作用，我仍然可以使用“试用”发送 api 测试。

有人可以帮我禁用此“试用”功能吗？

亲切的问候，本杰明