Tag: swagger

根据Swagger定义validationREST消息

我在IBM Integration Bus中工作，我发现myslef需要validation我所接收的消息。 由于IIB在这方面不支持任何类型的validation，我想知道是否有任何外部库可以为我validation这些消息。 到目前为止，我发现了这个https://github.com/swagger-api/swagger-inflector/blob/master/README.md#payload-validation但是我想知道是否有更适合我需求的替代方案。 谢谢你的任何建议。

swagger – 没有API的空列表

我试图使用swagger来记录我的Rest API。 我正在开发一个Tomcat / Spring服务器，其余的apis是使用Jersey开发的。 我按照招摇指南并将所需数据添加到我的web.xml： resources com.sun.jersey.spi.container.servlet.ServletContainer com.sun.jersey.config.property.packages com.wordnik.swagger.jersey.listing;app.servlet.resources.jersey;org.codehaus.jackson.jaxrs swagger.api.basepath http://localhost:8080/main/resources/ api.version 1 1 http：//：8080 / main / resources / api-docs返回以下内容： {“apiVersion”:”0.0″,”swaggerVersion”:”1.2″} 知道我在这里什么？

恩惠在招摇

我想知道如何以昂首阔步的方式记录枚举。 根据JavaDoc dataType。 有关支持的数据类型，请参阅文档。 如果数据类型是自定义对象，请设置其名称，或者不设置任何名称。 在枚举的情况下，使用’string’和allowableValues作为枚举常量。 但我没有找到一些好的Java示例如何真正使用它，规范在这里 。 Java的 第一次服务 package betlista.tests.swagger; import betlista.tests.swagger.model.Input; import betlista.tests.swagger.model.Output; import com.wordnik.swagger.annotations.Api; import com.wordnik.swagger.annotations.ApiOperation; @Api(value = “first”, position = 1) public class RestServiceFirst { @ApiOperation(value = “foo1 operation”, httpMethod = “POST”, position = 1, nickname = “foo”) public void foo1(Input input) { } @ApiOperation(value = “bar1 operation”, response = […]

如何生成离线Swagger API文档？

我有一个Spring Boot MVC java Web应用程序。 我已经能够集成Springfox for API文档。 当服务器启动并运行时，我可以直观地看到所有API。 如何生成OFFLINE swagger API文档？ 注意：我不想使用asciidoc或markdown文档，但我想在html文件中使用相同的swagger API用户界面。 我想这样链接是相对于本地目录而不是本地主机服务器链接。 谢谢

swagger @ApiModelProperty List 属性的示例值

我有一个类，其中有一个属性是List public class MyClass { …. @ApiModelProperty(position = 2) private List productIdentifiers; …. } 此代码生成示例值，如下所示： { “customerId”: “1001”, “productIdentifiers”: [ “string” ], “statuses”: [ “NEW” ] } 此处显示的示例值无效。 我期望的示例值应该是： { “customerId”: “1001”, “productIdentifiers”: [ “PRD1”, “PRD2”, “PRD3” ], “statuses”: [ “NEW” ] } 我尝试传递示例属性如下，但它没有生成正确的值： @ApiModelProperty(position = 2, example = “PRD1, PRD2, PRD3”) // This generates […]

Swagger for Spring MVC项目

关于在Spring MVC中集成Swagger： Swagger没有显示@RequestMapping的GET/PUT/POST文档 在我的Spring MVC Rest webservice应用程序中，我有一个Login控制器和一个Student Controller。 我只是配置了Swagger来生成Rest API文档。 参考： http ： //java.dzone.com/articles/how-configure-swagger-generate 问 ：然而，Swagger只显示类级路径，我猜它不会显示类级别@RequestMapping 。 ， 方法级别映射被忽略。 有什么理由吗？ @Controller @RequestMapping(value = “/login”) public class LoginController { @RestController @RequestMapping(value = “/students/”) public class StudentController { @RequestMapping(value = “{departmentID}”, method = RequestMethod.GET) public MyResult getStudents(@PathVariable String departmentID) { // code } @RequestMapping(value = “student”, method […]

使用Javadocs生成Swagger文档

我想为现有的一组RESTful API构建Swagger文档。 我有以下要求： 离线生成Swagger Doc（我使用了http://kongchen.github.io/swagger-maven-plugin/ ）。 这个插件帮助我在编译期间生成Swagger文档。 读取现有的Javadoc，以便可以在Swagger文档中使用它们。 到目前为止使用上面的插件我能够实现第1点。所以对于现有的REST方法： /** * * Gets the {@link DisplayPreferenceModel} with the name as provided in the parameter. The preference with the given name defined at the tenant or master level is returned. * This API gives us the preference if it is eligible for unauthorized access If it […]

在Swagger-UI中对API方法进行排序

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

如何为swagger REST API文档生成Java客户端代码

我的方案如下。 我有一个招摇.json例如： http ： //petstore.swagger.io/v2/swagger.json我想为上面的REST API使用生成的java客户端，例如： PetApi petApi = new PetApi(); Pet pet = new Pet; pet.setName(“cica”); pet.setId(1L); petApi.addPet(pet); System.out.println(petApi.getById(1L));` Expexted输出： cica和新宠物根据REST API实现存储。 我已使用以下命令为petstore成功生成服务器存根： java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l spring-mvc -o samples/server/petstore/spring-mvc 但是这个maven项目代码是一个服务器代码。 它有注释，如PetApi.java @RequestMapping ，还有一个WebMvcConfiguration.class 。 我不想拥有服务器存根。 我想拥有petstore REST API的客户端库。 有没有可以为我生成适当的客户端库的工具？ 我应该修改服务器存根，因此它有所有模型或者我应该使用简单的springRestTemplate吗？ 谢谢你的答案！