问题标签 [swagger]

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 投票
0 回答
767 浏览

swagger - Dropwizard - Swagger UI 未加载

我将该dist文件夹添加到我的项目中,并在 index.html 中将 url 更改为localhost:9090/api-docs我可以看到我的 apis 数组的位置。我的问题是“为什么没有加载 swagger ui?”

0 投票
1 回答
2182 浏览

api - 使用 Swagger 和 ServiceStack 记录响应类

在 wordnik 的petstore 示例中,他们为响应类提供了文档。在 /pet/{petId} 端点上可以看到一个示例:

看起来它支持以下参数:

  • 可选(指定属性是否始终在响应中的标志)
  • 允许值
  • 描述

有没有办法通过 ServiceStack 实现来实现这一点?

0 投票
2 回答
4732 浏览

swagger - 我们可以从 web.xml 中移动一些招摇的配置吗

在 swagger 1.2.9-1.2.3 或旧版本中,我们有配置阅读器com.wordnik.swagger.jaxrs.ConfigReader类,我们可以扩展这个类,我们可以声明 swagger 属性 swagger.api.basepath 、 api.version 、 swagger.version 等。

但是在 swagger 2.10-1.3.0 的当前版本中,这个类不存在。有什么方法可以从 web.xml 移动配置,我想将它们放在属性文件中,而不是在 web.xml 中硬编码。

提前致谢。

0 投票
2 回答
2828 浏览

jakarta-ee - Swagger 是否可以覆盖自定义对象序列化

我一直在测试 swagger,以便将其用作我的 api 服务的事实上的文档。我将休眠用于持久层,每个响应都绑定到一个实体。问题是这些实体与其他实体有依赖关系,当我在@ApiOperation 响应中传递对象时,我想安排大摇大摆地不显示这些实体。我能在网上找到的唯一想法是来自 github页面的这个链接。

我试过这样做:

但我收到此错误:

org.json4s.package$MappingException: 没有找到可以转换成 java.lang.String 的值

当我将某些类作为字段或列表找到时,有没有办法避免序列化它们以及如何?

0 投票
1 回答
1812 浏览

java - 如何将 JerseyJaxrsConfig 类作为 servlet 添加到 grizzly

我正在努力实现Swagger以生成 API 文档。我在这里遵循配置指南:https ://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart但它都是基于 XML 的,当我尝试做我认为在运行时等效的事情时配置灰熊抱怨 - Cannot resolve method 'addServlet(java.lang.String, com.wordnik.swagger.jersey.config.JerseyJaxrsConfig)'

似乎是,JerseyJaxrsConfig extends HttpServlet而不是Servlet. 关于我能做什么的任何建议?

0 投票
2 回答
4283 浏览

spring - Swagger Spring Access-Control-Allow-Origin。

我有一个 Spring Swagger 应用程序,我可以在 localhost 上成功运行。但是当我在 Heroku 上运行相同的项目时,出现以下错误:

XMLHttpRequest 无法加载http://force-com-rest-swagger.herokuapp.com/api/doc/api/v1/account。Access-Control-Allow-Origin 不允许来源https://force-com-rest-swagger.herokuapp.com 。

下面是我的招摇 js 配置:

有什么建议么?

0 投票
2 回答
6697 浏览

spring - NoSuchMethodError: com.sun.jersey.core.reflection.ReflectionHelper.getOsgiRegistryInstance()Lcom/sun/jersey/core/osgi/OsgiRegistry;

看来我有一个依赖冲突,我不确定如何解决。我正在尝试在我的应用程序中实现Swagger。我已经包含了我的 pom 以及堆栈跟踪。如果我可以包含其他任何内容来更好地描述问题,请告诉我。我不确定如何开始调试这个......

pom.xml

0 投票
0 回答
6970 浏览

scala - java.lang.NoSuchMethodError: scala.Predef$.augmentString(Ljava/lang/String;)Lscala/collection/immutable/StringOps;

我在这里遇到了一个错误,这与我的依赖项有某种冲突。我认为查看 hte 源代码会提供线索,所以我去org.fusesource.scalate.jersey.ScalateTemplateProcessorhttp://scalate.fusesource.org/maven/1.3/scalate-core/scaladocs/org/fusesource/scalate/jersey/ScalateTemplateProcessor.html . 我希望在这门课上找到一些东西来帮助我理解java.lang.NoSuchMethodError: scala.Predef$.augmentString(Ljava/lang/String;)Lscala/collection/immutable/StringOps;所指的内容。不幸的是,我仍然对这里实际发生的事情感到非常困惑。

scala.Predef$.augmentString(Ljava/lang/String;)Lscala/collection/immutable/StringOps;指的是什么类?

我的pom.xml

0 投票
1 回答
7716 浏览

spring - Swagger 吐出 xml 响应而不是 json

我春天一周大。我正在使用 Spring + maven + Jackson 开发一个纯 RESTful API 服务。在探索一些最佳实践时,我遇到了这个,所以我决定将 swagger 与 spring mvc(和 swaggerUI)一起用于文档。我经历了这个这个教程来做我想做的事。一切都很顺利,直到我意识到在点击 /api-docs 后我得到了 XML 响应,而不是教程和其他地方的 JSON 响应。当我添加 SwaggerUI 时,这将无法正常工作。后来我在这里发现 swaggerUI 需要 json。我总是可以在没有服务器集成的情况下返回并使用 swagger ( https://github.com/wordnik/swagger-core/wiki/Adding-Swagger-to-your-API),但这并不能真正满足我的需求。

以下是 pom.xml 的内容:

小服务程序上下文:

swagger.properties

我在 chrome dev http 工具中尝试了 GET /api-docs/ ,并将“Accept”标头设置为“application/json”,效果很好。这是否意味着我必须手动设置请求标头?我正在添加 web.xml 以防万一。

网页.xml:

我认为 swagger 不需要任何特殊注释,因此我的 java 代码库保持不变。

这个问题是不是太长了?请原谅我,因为我是新来的。请编辑和建议。

控制器类:

0 投票
0 回答
1715 浏览

asp.net-web-api - SwaggerUI not working with API versioning

I'm trying to use SwaggerUI, but I'm having some problems.
When I call http://mysite.com/api/swagger I get this:

But, when I call http://mysite.com/api/docs/V1.Foo or http://mysite.com/api/docs/V2.Foo I get this:

It look like I'm calling my API, but I'm trying to get the API documentation.

All my controllers implement System.Web.Http.ApiController.

This is my WebApiConfig:

And this is my IHttpControllerSelector implementation (VersionControllerSelector):

SwaggerActionFilter doesn't get my request when I call http://mysite.com/api/docs/"some-controller".
If I use SwaggerUI in another Solution without versioning, I'm able to get all documentations.

I know that maybe my versioning selector is wrong, but I dont't know what is wrong.