swagger,swagger-ui
Is it possible to have same path appear more than once in one API spec which is being rendered by Swagger-UI? Should I create separate api specs and load two instances of Swagger-UI? What is the best way to handle this? For ex. I have endpoint called /oauth/token which I...

jax-rs,swagger,swagger-ui
While documenting an operation using @ApiOperation, there is the notes atribute for a long description of the operation. But putting a long description in the annotation makes it cumbersome and difficult to mantain. Is there a more elegant option to reference an external file or something?...

import,swagger,bluemix,swagger-2.0
Is it possible to define an API icon in the Swagger 2.0 definition that will be shown on the app developers page? Or is it at least possible to set an API icon in the API Manager UI? I could not find anything related. ...

mime-types,swagger,swagger-ui
In Swagger UI, is there a way to supply a MIME boundary that can be included in the Content-Type header? Using Swagger, I can generate / submit different content types in Swagger UI by using the consumes property in the Swagger Spec, e.g. application/json, application/xml, etc. However, I need to...

java,playframework,routes,swagger
I am developing an API with Swagger UI using Play Framework. But I got a little problem (not a big problem) : My URL are : https://url/find?param1=false&&&param4=1 But I have '&&' when a parameter is not given ( I mean param2 and param3) What I want is simply : https://url/find?param1=false&param4=1...

configuration,swagger
Im new Swagger user. I created endpoint with long model definition. But when endpoint is attached to api-docs, this is not working. I checked that that endpoint configuration file is valid JSON file. How to check where is the problem with with this file? Im using Swagger 1.2....

swagger,swagger-ui
I'm working on an API which also generates swagger documentation. The issue is that for some reasons the request model/schema is not displayed in swagger UI but I don't get any error either. I need to represent map to an array of strings . e.g. map[string][]string. Definition object definition is...

ruby,swagger,grape,api-doc
I'm using the grape-swagger gem and I'm being unable to get a Grape-based API properly described in Swagger. Using: grape (0.11.0) and grape-swagger (0.10.1) When I enable the Swagger json listing I get this output listing all endpoints but not the methods contained in each endpoint. My output: { "apiVersion":...

java,spring,spring-mvc,swagger,swagger-ui
this is a very simple thing usually but I have sat with it for long and have tried multiple configurations and git repositories but can't get it to work. The errors I receive looks like this: SEVERE: Exception sending context initialized event to listener instance of class org.springframework.web.context.ContextLoaderListener org.springframework.beans.factory.BeanCreationException: Error...

swagger
I have some parameter defined in the root parameters parameters: fooParam: name: foo in: query description: Foo foo foo. required: false type: number format: int32 Now I reference it in a path /pathOne: get: parameters: - $ref: "#/parameters/fooParam" Let say I want to use that parameter in another path or...

node.js,model-view-controller,sails.js,swagger
I want to develop an API using the MVC pattern. I found sails framework interesting and I'd like to know if it's possible to configure swagger or something like with sails to generate the documentation of my API (something like swagger-express for express for example). Thanks!...

asp.net-web-api,swagger
I am using Swashbuckle for API documentation, works great but Swashbuckle seems to serialize objects in camel case, and I use NewtonSoft lib to serialize objects, which has an attribute [JsonProperty(name="")] and these are used during serialization. Is there a way I can customize Swashbuckle to use the same serializer...

node.js,npm,gulp,swagger
I've decided the most logical way to maintain an enormous Swagger document is to decompose it into node modules and then have a Gulp task that builds them all together. I would however like to validate the Swagger after it's written. Is there a plugin to do this?

swagger,swagger-ui
I'm trying to develop a schema compliant with the swagger specifications. See below. The definitions(model/schema) of the Parameters and Responses are not displayed in the swagger-ui interface so my question why is that. The schema passes the swagger validator. { "swagger": "2.0", "info": { "version": "1.0.0", "title": "example", "description": "provides...

node.js,swagger,hapijs
Since the npm module hapi-swagger doesn't support file upload endpoints I need a way to skip certain endpoints in my tests. I've checked the docs and there's no beforeEach or any way to check which endpoint is which during the test runs. Currently I've just got my environment set to...

php,github,composer-php,swagger
I struggle loading a fork for a package with composer. I am trying to integrate Swaggervel, a Swagger package for Laravel 5, into my project. The current dev-master has a bug which causes incompatibility to laravel 5. BUT there is a fork on github https://github.com/mvpasarel/swagger-laravel which fixes this issue. So...

swagger,swashbuckle,swagger-2.0
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 ...

swagger,swagger-ui
I have following in my code @Path("/description") @Produces(MediaType.APPLICATION_JSON) @Api(value="description", description="Service description") public class Service{ .... } On swagger UI I am able to see description: true Instead of description: Service description Please help. What am I missing?...

swagger,swagger-ui,swashbuckle,swagger-2.0
I have a ASP.NET Web Api 2 application. I added Swashbuckle to it (Swagger for .NET). It displays my endpoints no problem, but in order to send a request I need to attach an Authorization header to that request. If I understand correctly in order to do that I need...

swagger,swagger-ui
I am defining my response as per: responses: 200: description: 'An authProvider object' schema: type: 'array' items: $ref: '#/definitions/AuthProvider' Is it possible for me to directly attach another field or 2 in the response? I would like to add something that I don't want to put into AuthProvider...

swagger,raml
So I've been building a service that taps into popular APIs around the web and I've found Swagger to be a huge asset to the project. Instead of writing a ton of custom code that is difficult to maintain, I've been able to use Swagger definitions to dynamically create all...

.net,web-services,servicestack,swagger
I am trying to use ServiceStack.Api.Swagger and by default swagger url is pre-populated with /swagger-ui/resources While for self-hosted ServiceStack service it is available right under /resources How can I change routing for self-hosted service for embedded swagger resources or update default swagger url. Routing update is preferable way as it...

java,spring-mvc,java-ee,swagger,swagger-ui
I have problem with configuring swagger. When I specify link for servlet in web.xml like <servlet-mapping> <servlet-name>appServlet</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping> swagger shows url-s without .../rest/... so I can't use swagger-ui for testing, when I specify url-pattern /* swagger-ui don't work. Here is configuration class @Configuration @EnableSwagger public class DocumentationController extends WebMvcConfigurerAdapter...

swagger
I have the following: @JsonIgnore public String getPassword() { return password; } @JsonProperty public void setPassword(String password) { this.password = password; } What I'd like is for the swagger UI to show the password field on my POST function still as I am only hiding it from the GET call....

asp.net-mvc,asp.net-web-api,swagger,swashbuckle
I have an existing Swagger.json file for a .NET WebApi site which I would like to integrate with my developer site (which is at a different url) running Swashbuckle. Can I simply copy this swagger.json file to the mvc site (content or app_data folder and do this?) If I can,...

swagger,swagger-ui,swagger-editor
I'd like to know if the following is possible. Swagger is almost what I need to document a Message based API. For instance for a Command Message I'd like to say "Command" instead of "Post", and instead of "path" I'd like to have the name of the Command. The spec...

c#,rest,asp.net-web-api,swagger,swashbuckle
all. I am trying to document a WebApi 2 using Swashbuckle package. All works great if the API is running by itself i.e. localhost/api/swagger brings me to ui and localhost/api/swagger/docs/v1 to json. However the producation app initializes this same Webapi project by running webapiconfig method of this project from global.asax.cs...

api,rest,jax-rs,swagger,hydra
I've been looking for automatic creating the documentation for the REST API of a project I'm working on. First, Hydra (http://www.hydra-cg.com) shows up with an interesting idea for designing Web APIs. Later some colleagues recommend me to use Swagger 2.0 (http://swagger.io) as code generator. Then, I realise that both specifications...

javascript,node.js,documentation,swagger
I have created Restful APIs in Node.js and now I plan to document them so they can be shared with others. I spent the past couple of days researching in to this and I found Swagger and started exploring what it had to offer. I really like Swagger-UI, It takes...

swagger,swagger-ui
I have an API call whose response includes a status field with a large number of potential status codes. These codes are numeric and thus not self-explanatory. Using Swagger.io how can I provide a table of these status codes with their corresponding description?...

spring-security,spring-boot,swagger,swagger-ui,swagger-maven-plugin
Swagger works! I can interact with http://localhost:8090/sdoc.jsp and everything is fine. I add the following to pom.xml... <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> I also add the following two files: @Component public class CustomAuthenticationProvider implements AuthenticationProvider { @Override public Authentication authenticate(Authentication authentication) throws AuthenticationException { String name =...

java,spring,spring-mvc,gradle,swagger
I setup Swagger for my Spring MVC project as described in Swagger-springmvc README. I use Spring Java Configuration not XML-based Spring configuration. As build system I use Gradle. When I perform GET request to api-docs I get following JSON {"apiVersion":"1.0","apis":[],"authorizations":{},"info":{"contact":"My Apps API Contact Email","description":"My Apps API Description","license":"My Apps API Licence...

java,api,rest,jersey,swagger
I have RESTful service based on Jersey 1.18.1 and I want to show my API via Swagger. Firstly I have to get JSON. I read this instruction: Swagger Core Jersey 1.X Project Setup 1.5. Swagger allows to set up a configuration different methods and I decided to use custom Application...

asp.net-web-api,swagger,swashbuckle
could anyone know how could i integrate basic auth with swashbuckle api's documentation? I saw that there's a basicAuth function in the swaggerconfig file: c.BasicAuth("basic").Description("Basic HTTP Authentication"); What i've done: uncommented the previous line but nothing changed! does anyone have any idea what did i miss? Thanks!...

java,yaml,swagger
I started working recently on swagger to generate documentation for our RESTful apis. I use the yamlbeans-1.09.jar to convert my Java DTOs to a yaml file. Everything works fine and the yaml is even validated properly on the http://www.yamllint.com/ but still while testing it with the Swagger interface, it gives...

java,spring,swagger,swagger-ui,apache-wink
UPDATED with SOLUTION below!!! ////////////////////////////////////////////////////////////// Thanks to the advice of Ron below I slightly modified my setup to use BeanConfig instead of SwaggerConfig and got this working. In order to do this I had to modify the servlet and also (and this is where I believe the missing piece was)...

reference,swagger,swagger-2.0
I have multiple parameters that I want to reference, but I do not want to specify them one by one. This snippet does not make the parameters show up: { ... "paths": { "/stuff": { "get": { "description": "Gets stuff", "operationId": "getStuff", "parameters": { "$ref": "#/definitions/set1" } } } },...

swagger
I am using swagger-springmvc and swagger-codegen to generate a Java client library for a RESTful webservice. I have written my own extension of the BasicJavaGenerator (see below) to override the package names, and can successfully generate the client library files. The "main" files generated are: swagger-codegen/generated-code/java/pom.xml swagger-codegen/generated-code/java/src/main/java/com/example/ApiApi.java swagger-codegen/generated-code/java/src/main/java/com/example/model/*.java What I...

swagger,swagger-editor
I am trying to get a multi-line literal in Swagger editor (awesome tool, by the way!). post: summary: Translate one or more identifiers description: | Translate one or more identifiers for one entity into the identifiers of another entity. Translate one or more identifiers for one entity into the identifiers...

attributes,asp.net-web-api2,swagger,swagger-ui,swashbuckle
Is it possible to leverage MultipleApiVersions in Swagger UI / Swashbuckle when using attribute routing? Specifically, I implemented versioning by: using System.Web.Http; namespace RESTServices.Controllers.v1 { [Route("api/v1/Test")] public class TestV1Controller : ApiController { ... } Version 2 would be in a v2 namespace. In a controller named TestV2Controller. The route would...