问题标签 [swagger-editor]

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 回答
2647 浏览

editor - How to Specify POST with JSON body in Swagger Editor

i have a POST method REST API with request body as json, which has

I need to know how to set parameter for variants in the above json in swagger 2.0 editor, also referenced documentation and petstore sample from swagger but i cant find any clue.

0 投票
1 回答
1489 浏览

swagger - 如何在 swagger 2.0 中声明集合资源模型?

我不确定我应该如何在 swagger 上为集合资源声明模型。

规范缺少一些示例,所以我猜是这样的:

然后 swagger 编辑器显示以下生成的文档:

从招摇编辑器打印

这是对的吗?

0 投票
1 回答
624 浏览

swagger - 如何在 Swagger Editor 中启用 Desinger 模式?

我是 swagger 编辑器的新手。在编辑模式下,我已经很好地完成了 api 文档。但是在 opera、chrome、Firefox 中没有启用设计器模式。如何在我的浏览器中启用此功能。?这是我在编辑器模式下完成的示例。

如何使用 Desinger 模式做到这一点?请帮我 。

0 投票
2 回答
576 浏览

swagger - swagger-editor 中的继承引发错误

当我尝试从包含数组的模型继承时,使用 swagger 编辑器并收到验证错误。我假设我的定义被搞砸了,因为我是新来的。但我确实知道在编辑器中支持 swagger 2.0 仍有工作要做。不想指出编辑器中的错误或缺陷,只想知道我的架构是否有效。

这在编辑器中有效(来自简单的 petstore 示例):

但是我想将宠物定义为一个数组:

0 投票
2 回答
2520 浏览

django-rest-framework - 在本地运行的 Swagger-editor 显示空白页面

我是新来的。

我在 django-rest-framework 中创建了 API。我想记录它们。因此阅读有关招摇。

我尝试了 django-rest-swagger,但由于缺乏文档,我无法使我的代码适合文档。因此,我正在尝试使用 swagger 编辑器,它可以让我从头开始设计 API 结构。我已在本地安装它,但它在“127.0.0.1:9000”处显示空白页面。我现在该怎么办 ?

我想编写将由本地安装的 swagger-editor 使用的 YAML 或 JSON 文件。我怎样才能做到这一点?

这是我加载 127.0.0.1:9000 时控制台上的错误

0 投票
4 回答
46802 浏览

yaml - 招摇编辑器中的多行文字?

我正在尝试在 Swagger 编辑器中获取多行文字(顺便说一句,很棒的工具!)。

我试过 | 和 >,具有不同的结尾(增加缩进与空行),以及我能想到的各种方式,但它总是给出相同的错误:

我看到 JS-YAML 的错误表明问题是最后的 Windows 样式换行符,我知道 HTML textareas 可以创建它。这是我第一次真正大量使用 YAML,是我做错了什么,还是 Swagger 编辑器中的错误?

0 投票
1 回答
696 浏览

api - Swagger 代码生成器 - 有经验的人吗?

最近,我们的团队开始使用http://swagger.io/,在稍微调整了我们需要的工作方式之后,它对我们来说效果很好。带有预建文档的 Swagger UI 非常有用。

我们开始使用 Swagger 的另一个原因是尝试利用Swagger 代码生成,这是轻松生成 SDK 的希望。需要花点时间才能弄清楚,但是一旦配置好,它似乎就做得不错了。

最后,我的问题是,有没有人有使用 Swagger Code Gen 的经验,并且可以谈谈他们的经验?我们觉得它有点不成熟(在这个阶段),并且正在尝试平衡多少值得调整 Swagger Code Gen 以使其工作,甚至妥协我们的 API 的某些方面来实现它。

谢谢丹

0 投票
1 回答
607 浏览

swagger-ui - Swagger.io - API 文档生成器

我想将 Swagger.io 用于我的 API 文档。问题是他们的文档,说得委婉些,很烂。

我正在使用他们的编辑器:http ://editor.swagger.io并希望完全按照在此页面上看到的结果下载输出结果(包括 html 模板)。

以前有人做过吗?我只是无法下载正常工作的东西。

0 投票
4 回答
23509 浏览

documentation - Slate vs Swagger - 哪个更好,哪个有更多选择?

我必须记录我的 API。我必须使用其中任何一个SlateSwagger。我想知道哪个有更多的选择,利弊,哪个更好。

0 投票
1 回答
1655 浏览

java - Swagger Annotation - 没有参数时不包含参数?

我有 swagger-jersey2-jaxrs 1.5.1-M2 与 Drop-wizard 集成。我使用包含在资源和模型中的 swagger 注释生成了以下 yaml:

请注意,参数:包含在从 swagger 生成的 yaml 中。当我将其粘贴到 swagger 编辑器 2.0 中时,它会抛出一个错误,提示“数组太短 (0),最小值为 1”。

有没有办法不生成参数:在 yaml 当 URL 不需要任何参数时?我没有包含任何参数注释,它仍然显示在生成的 yaml 中。