swagger

问题 I'm building an OpenAPI (Swagger) 2.0 definition for the following XML payload to use within the Swagger UI: <addressElement> <key type="RECORD_ID" item="3">Enter value here</key> </addressElement> I'm having an issue figuring out how to display the default value 'Enter value here' for the element key . Where would one place this default value in an OpenAPI definition? My definition looks like this: "definitions": { "addressElement": { "type": "object", "title": "Address Element", "properties

问题 I'm building an OpenAPI (Swagger) 2.0 definition for the following XML payload to use within the Swagger UI: <addressElement> <key type="RECORD_ID" item="3">Enter value here</key> </addressElement> I'm having an issue figuring out how to display the default value 'Enter value here' for the element key . Where would one place this default value in an OpenAPI definition? My definition looks like this: "definitions": { "addressElement": { "type": "object", "title": "Address Element", "properties

问题 I am using plain vanilla JAXRS in a provided Application Server with Swagger 1.5.18. I can get the Swagger annotated classes to appear in the swagger.json , but I am having trouble setting the Swagger to scan for non annotated classes, those with just the @Path JAXRS annotations. I currently have the BeanConfig in the Class that is extending Application . I tried using a Servlet that extended DefaultJaxrsConfig with @WebInitParam(name="scan.all.resources", value="true") but that did not work

问题 As I was adding swagger to my API, I wanted to get default values and response examples. I added the NuGet packages and tried to follow this tutorial. The SwaggerResponseExample attribute works properly but the SwaggerRequestExample seems to be simply ignored. With my action defined as follow [SwaggerRequestExample(typeof(int), typeof(PersonExamples.Request))] [SwaggerResponseExample(200, typeof(PersonExamples.Response))] /* more attribute & stuff */ public IActionResult Get(int id) { /*

问题 I have a route with an optional parameter: [Route("{categoryId?}")] public HttpResponseMessage Get(int? categoryId=null) However, when I don't provide a value for categoryId the call includes {categoryId?} in the request itself... http://myhost/api/%7BcategoryId%7D 回答1: Swagger has no support for optional path parameters. If you wish to document it this way, you'd have to create two separate paths - one without the path parameter and one with. 来源： https://stackoverflow.com/questions/30182657

问题 This is my Interface ClassA .java @Path("/"+Paths.STORIES) @ApiModel(value = "Name API") @Api(value = "/stories", description = "Name API") public interface ClassA { @GET @Path("/"+Paths.STORYID) @Produces(MediaType.APPLICATION_JSON) @ApiOperation(value = "Fetch Story by ID", notes = "More notes about this method") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 200, message = "Invalid ID supplied"), }) public Response getNameFromID(

问题 This is my Interface ClassA .java @Path("/"+Paths.STORIES) @ApiModel(value = "Name API") @Api(value = "/stories", description = "Name API") public interface ClassA { @GET @Path("/"+Paths.STORYID) @Produces(MediaType.APPLICATION_JSON) @ApiOperation(value = "Fetch Story by ID", notes = "More notes about this method") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 200, message = "Invalid ID supplied"), }) public Response getNameFromID(

问题 I've a requirement to create a HTTP API layer over a legacy API interface written in C++. My plan is to generate the Swagger or open API file and then make it available to bunch of projects that needs to write a client (who will be consumer of new API) or a server (wrapper to legacy API). Is there anything that can expedite this requirement (other than manually parsing them and creating swagger spec file)? i.e. using C++ code to generate swagger JSON/YML file 回答1: Quite late answer and I

问题 I've a requirement to create a HTTP API layer over a legacy API interface written in C++. My plan is to generate the Swagger or open API file and then make it available to bunch of projects that needs to write a client (who will be consumer of new API) or a server (wrapper to legacy API). Is there anything that can expedite this requirement (other than manually parsing them and creating swagger spec file)? i.e. using C++ code to generate swagger JSON/YML file 回答1: Quite late answer and I