swagger-2.0

I would like to use an enum defined in definitions as part of my parameter definitions in a query string. I'm defining the Swagger Enum in the definitions part of my Swagger 2.0 spec file. OperationType: type: string enum: - registration - renewal I can create references to it in other definitions: Operation: type: object properties: name: type: string type: $ref: '#/definitions/OperationType' I can use the schema tag to make a reference to it when the parameter is in: body , but not when it's in: query - name: operation in: body description: description schema: $ref: '#/definitions

I'm struggling with the syntax of swagger to describe a response type. What I'm trying to model is a hash map with dynamic keys and values. This is needed to allow a localization. The languages may vary, but english should always be provided. The response would look like this in JSON: { id: "1234", name: { en: "english text", de: "Deutscher Text" } } My first try was looking like that, but I have no idea how to write the part for the name. AdditionalProperties seems to be a key, but I can't wrap my head around it. Also the requirement for english text is a mystery to me in this syntax and the

My project has Spring Security. Main issue: Not able to access swagger URL at http://localhost:8080/api/v2/api-docs . It says Missing or invalid Authorization header. Screenshot of the browser window My pom.xml has the following entries <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> SwaggerConfig : @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() {

I trying to map below JSON to Swagger YAML in swagger editor 2.0 and I am not sure how to set mixed array types into my schema { "obj1": [ "string data", 1 ] } Now, my swagger definition has, schema: object1: type: array items: type: string Helen The answer depends on which version of the OpenAPI Specification you use. OpenAPI 2.0 OpenAPI 2.0 (Swagger 2.0) does not really support mixed-type array and parameters. The most you can do is to use a typeless schema {} for items , which means the items can be anything (except null ) – numbers, objects, strings, etc. You cannot specify the exact types

I am trying to create a proper, REST API, and document it with Swagger (2.0). So, I have an API call that is a query, ie, it makes no changes and doesn't create anything (idempotent and safe). But it requires passing in a complex JSON parameter (list of items, 2 or 3 sets of addresses, etc). So I'm doing a GET with a parameter thats URL encoded JSON. That seems like the proper way to do it. I see so often API's like this where they do it as a POST for this reason, but that's an incorrect use of the POST verb. I'm seeing lots of swagger API's that do this... I can't figure out if there's a way

Is there a way i can remove the "basic-error-controller" from springfox swagger-ui? Picture: You can restrict the request handler selector to scan only the package of your project: return new Docket( DocumentationType.SWAGGER_2) .select() .apis( RequestHandlerSelectors.basePackage( "your package" ) ) ... It can be done using Predicates.not() . @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .paths(Predicates.not(PathSelectors.regex("/error.*"))) .build(); } I think, the most elegant solution

Let's say I've got a parameter like limit . This one gets used all over the place and it's a pain to have to change it everywhere if I need to update it: parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 Can I use $ref to define this elsewhere and make it reusable? I came across this ticket which suggests that someone wants to change or improve feature, but I can't tell if it already exists today or not? Ron This feature already exists in Swagger 2.0. The linked ticket talks about some specific mechanics of it