问题标签 [nelmioapidocbundle]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1391 浏览

symfony - 为什么自定义路由在 Nelmio API Doc 中出现两次?

我尝试为我的一个 API 定义自定义路由名称,从那时起,API Doc 显示该路由两次。任何想法为什么?

这是我的 API 的定义:

以下是路线在我的文档中的显示方式: 在此处输入图像描述

这是我的routing.yml文件:

0 投票
1 回答
995 浏览

symfony - NelmioApiDocBundle 对 swagger 2.0 的支持

我使用NelmioApiDocBundle v2.13.0处理symfony 2项目,该项目转储基于Swagger 1.2女巫的 Swagger 兼容 JSON API 定义是一个旧版本。我搜索了很多关于 NelmioApiDocBundle 对Swagger 2.0的支持但没有任何好的回应。这些是我发现的链接:

我想知道NelmioApiDocBundle 是否支持Swagger 2.0。以及是否有另一个捆绑包可以替换此捆绑包。

0 投票
1 回答
770 浏览

symfony - 返回没有数据库的实体 Nelmio Symfony

我使用 Nelmio 自动生成我的 api 文档。我想在 responseMap 中返回一个对象,它是一个简单的类(没有关联数据库的实体),如下所示:

但是我的 api 文档中没有显示响应对象。谁能帮我 ?谢谢。

0 投票
1 回答
247 浏览

symfony - Nelmioapibundme - 如何删除正文请求中的 json 格式

我只想发一个帖子来测试我的应用程序中用户的创建但是每次我因为在正文请求中发送的参数而出现错误时

您可以在正文请求中看到格式 json

请如何删除正文请求中的“_format”:“json”。

这是我的 config.yml 和 FosRest 和 Nelmio Api Bundle

使用 fosrest 和 nelmio api 包查看我的 config.yml

0 投票
3 回答
1312 浏览

symfony - 设置 Nelmio ApiDoc 返回参数说明

在控制器的 ApiDoc 中,我们已经指定了输出响应对象,现在我们看到了所有返回参数的列表。 输出参数 我们如何为此列表中的版本和/或描述字段提供值?

我尝试添加@ApiDoc(description="text")到响应对象的参数,但这似乎没有做任何事情。

提前致谢。

0 投票
2 回答
579 浏览

symfony - Symfony2:为什么 NelmioApiDocBundle 中的视图注释不起作用?

我想为我正在构建的 api 拆分我的文档。我正在使用 NelmioApiDocBundle,他们有一个完美的视图注释方式。Nelmio 视图 问题是我的方法停留在默认视图中,而不是在建议的 oauth 视图中:

所以 /doc/api/oauth/ 或 /api/doc/oauth 以 404 结尾

0 投票
1 回答
1204 浏览

symfony - Swagger-UI Symfony NelmioAPiDoc 添加多个 responseType 选项

我正在寻找一种向通过 NelmioAPiDoc 实现的 swagger-ui 添加多种响应类型的方法

在此处输入图像描述

我想选择 image/jpeg 作为响应类型 我有代码可以在控制器中工作以将主体设置为图像即使响应类型仍然是 application/json 但我的目标是如果 'application/json' 是selected 它以 json 格式返回图像的 url,但如果选择了“image/jpeg”,它会将图像返回到正文。非常感谢任何帮助。

我也尝试将它添加到我的班级顶部,但仍然有一个下拉选项

0 投票
1 回答
1557 浏览

php - Symfony:在 nelmio api 文档中输出示例图像?

我正在使用Nelmio Api Doc为我的 API 生成文档。我刚刚添加了一个新端点,它根据 id 参数返回图像/png 文件。我如何在我的 api 文档中最好地表示这个响应?理想情况下,我希望在此端点的文档的示例响应部分中显示示例图像。但是我可以用 nelmio 做到这一点吗?请看下面:

0 投票
1 回答
690 浏览

php - 如何独立使用 nelmio/api-doc-bundle(没有 symfony 应用程序)?

我的 Web 应用程序不是基于 Symfony 或任何其他开源框架。

我如何仍然使用包 nelmio/api-doc-bundle 从类注释生成我的 API 文档?

0 投票
1 回答
3771 浏览

php - Symfony NelmioApiDocBundle swagger-ui PHP Annotations json对象,对象属性数组未显示

我正在尝试使用 NelmioApiDocBundle 发布 json,我显示了 json 示例,但尝试示例中没有显示数组对象属性?我尝试了几种方法来完成此操作,但均未成功,以下是我尝试过的代码。非常感谢任何帮助。

当我尝试为项目添加示例时,它会在数组周围加上引号,因此它不是有效的 json,我必须转义引号,所以它添加斜杠不是我想要的

这是试图在正文中发布的 Json

下面的注释

在此处输入图像描述