Tag: swagger ui

Spring REST / Swagger / Postman – 已下载损坏/空白文件: 我按照这篇文章的function：客户端可以下载文件（即csv，pdf和zip）。但要么我得到的pdf是空白的，要么尝试使用zip文件时，它会受到损坏。只有CSV工作正常。我检查了标题，一切看起来都符合标准。我甚至没有使用“application / octet-stream”和pdf使用“application / pdf”，csv使用“application / csv”，zip使用“application / zip”只是为了避免客户端出现任何问题。我正在使用swagger 2.4测试我的apis。这是我的代码。 @CrossOrigin @Controller public class ReportRestController { @Autowired ReportService reportService; @Value(“${report.temp.directory}”) // used for storing file in local private String reportLocation; @ApiImplicitParams({ @ApiImplicitParam(name = “Authorization”, value = “Authorization”, required = true, dataType = “string”, paramType = “header”), @ApiImplicitParam(name = […]

Swagger无法为HTTP“PATCH”生成文档: 我遵循了以下内容博客文章： http ： //kingsfleet.blogspot.co.uk/2014/02/transparent-patch-support-in-jax-rs-20.html https://github.com/jersey/jersey/tree/2.6/examples/http-patch 创建端点以支持Jersey 2.6依赖版本中的HTTP“PATCH”方法： -Jersey: 2.6 -swagger-jersey2-jaxrs_2.10: 1.3.12 题？为什么Patch终点没有被列为swagger ui文档的一部分？分析：如果我使用此注释进行注释，则会生成该端点的文档，但不会进行交互。 @com.wordnik.swagger.jaxrs.PATCH 配置 JerssyApplicationInitializer packages(true, “com.test.account.endpoint”, “com.wordnik.swagger.jaxrs.json”); //Swagger Configuration register(new ApiListingResourceJSON(), 10); register(JerseyApiDeclarationProvider.class); register(JerseyResourceListingProvider.class); //Genson Converter register(GensonJsonConverter.class, 1); register(createMoxyJsonResolver()); 我不确定，如果我遗失了什么，任何帮助或指南都会有所帮助。补丁方法doscumets： public static final String PATCH_MEDIA_TYPE = “application/json-patch+json”; @PATCH //@com.wordnik.swagger.jaxrs.PATCH @PreAuthorize(userAuthenticationRequire=true) @Consumes(PATCH_MEDIA_TYPE) @Path(“{id: .\\d+}”) @ApiOperation(value = “Update Client Details […]

如何更改Swagger中成功操作的响应状态代码？: 如图所示，它为添加操作显示“响应类（状态200）”。但是，添加操作的实现方式是永远不会返回200.成功时返回201。我的问题是如何将（状态200）更改为（状态201）？该部分的代码如下： @RequestMapping(method = RequestMethod.PUT, value = “/add”) @ApiOperation(value = “Creates a new person”, code = 201) @ApiResponses(value = { @ApiResponse(code = 201, message = “Record created successfully”), @ApiResponse(code = 409, message = “ID already taken”) }) public ResponseEntity add(@RequestParam(value = “name”, required = true) String name, @RequestParam(value = “id”, required = true) […]

从现有REST API生成Swagger文档: 鉴于现有的JAX-RS注释API接受并返回带有jackson-annotated类型的json，有没有办法可以生成一些YAML Swagger文档？我的计划B是编写一些使用reflection来查找REST注释类型的代码，创建其参数和返回的哈希映射，然后为Jackson注释抓取这些类，并以这种方式生成文档。我更愿意使用已经存在的解决方案来编写一次性的东西。我发现这个Swagger模块声称它可以解析Jackson的配置（ https://github.com/FasterXML/jackson-module-swagger ），但我不太了解Swagger了解哪些模块以及我是否可以使用它来从现有代码生成Swagger。

生成REST API的Swagger UI文档: 我在Java中使用JAX-RS / Jersey开发了我的REST API。我想为它转换为/生成基于Swagger的UI文档。任何人都可以告诉我精确/步骤简单的方法如何这样做？对不起，但他们网站上给出的步骤对我来说有点模糊。

如何在Spring启动rest应用程序中使用Swagger ui使用密码流配置oAuth2: 我有使用另一个Spring启动授权服务器的spring boot rest api（resources），我已经将Swagger配置添加到资源应用程序中，以便为其余的API获得一个漂亮而快速的文档/测试平台。我的Swagger配置如下所示： @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private TypeResolver typeResolver; @Value(“${app.client.id}”) private String clientId; @Value(“${app.client.secret}”) private String clientSecret; @Value(“${info.build.name}”) private String infoBuildName; public static final String securitySchemaOAuth2 = “oauth2”; public static final String authorizationScopeGlobal = “global”; public static final String authorizationScopeGlobalDesc = “accessEverything”; @Bean public Docket api() { List list […]

Swagger 1.5不显示我的1.2的@Api描述？: 我最近将一个项目从Swagger API 1.2升级到2.0（或者用Swagger核心术语，从1.3升级到1.5）。由于他们出色的移民指南，我设法在很短的时间内完成了这项工作，几乎没有任何障碍。唯一困扰我的是缺乏对@Api注释的description值的支持。端点被精心记录 – 包括顶级API端点 – 但它们的描述不再在UI中显示：请注意，缺少某些东西？一些研究（意思是，阅读源代码）产生了相同的description现在已经过时，为更@Tag注释@Tag 。但是我找不到有关如何应用它们的信息，因此描述仍然存在于每个端点类中。使用Dropwizard，有没有办法以编程方式在Swagger 1.5中实现这一点？

在Swagger-UI中对API方法进行排序: 我找不到任何工作示例，如何实现以下内容：我希望我的Swagger-UI中的API方法按方法（GET-POST-PUT-DELETE）或/按字母顺序排序。到目前为止，所有方法都以随机顺序显示，甚至不按给定源代码的顺序显示。我使用Jax-RS + Jersey 1。使用@ApiOperation的position属性进行排序对我来说不是一个选项，因为有太多方法且API仍在扩展，所以如果有新的方法我需要更新所有方法。任何提示？