Problem statement: I want to automate the generation of machine and human readable specifications for JSON APIs so anyone can visualize and interact with our API. One of the feasible solution is to...

I have my swagger definition like : someDef: type: object properties: enable: type: boolean default: false nodes: type: array maxItems: 3 items: type: object properties: ip: type: str...

It's my first post so feel free to leave some feedback or if i do something wrong :) I am using spring-boot and resteasy : <!-- Spring Boot --> <dependency> <groupId>org.spring...

Reviewing the swagger documentation specifically the annotations I did not find how to define the host and basePath properties. Any idea where to set them? documentation consulted: Swagger-2.X---A...

I have the following api documentation: swagger: "3.0" info: version: 0.0.1 title: Test API paths: /users: get: summary: Get all registered users produces: - application/json responses: 2...

Context I would like to use AutoRest generated client for a webapi service by using "Add"/"REST API Client..." in visual studio 2017. However, it gives the following error: [Info]AutoRest Core 0....

As far as I checked on many swagger files of Amazon/Google and more, That error code (or generally error codes of 5xx family) is not shown as a part of the swagger files. Is their a reason for that...

I am trying to define a query parameter in Swagger with comma-separated strings from a predefined set of items like ?fruits=Apples,Oranges,Bananas but I get the following error from the swagger edi...

I would like to customize the example values for my API documentation I am making with Springfox's Swagger (Spring REST API). Since the request body is a stringified JSON via JQuery AJAX, the @Req...

I'm coding REST APIs in Spring Boot. I want to make sure that my code is readable to front-end developers using Swagger API development tool (Swagger). For example @GetMapping("/getOne") ...

I have a Swagger spec that defines a HEAD operation: head: description: show flight exist or not. parameters: - name: flight_no in: path type: string description: Flight_no required: true ...

Background I've just started a new project and would like to use Swagger for my API Documentation. I am currently running my project locally, hosted in IIS. I have modified my hosts file to give...

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...

I would like to put a Markdown code block in the description of my API but the Swagger UI seems to be reading as though it was a single line code snippet. I currently have: description: | This A...

I'm using swagger2 in my spring boot project. It's working well, but I need to exclude the basic-error-controller from the api. Currently I'm using the following code using regex. It's workin...

I have an Angular 4 application, which I am upgrading to Angular 5. I am getting the following error. ERROR in src/app/application/services/generated/variables.ts(1,10): error TS2305: Module ...

I am integrating my JAX-RS REST project with Swagger. I read many documentation and tutorials and my favourite figure is the following (thanks to Philipp Hauer's blog): That image helped me a lot ...

I am trying to create documentation for my REST API written in golang using Swagger. I have been following this guide: https://goswagger.io/generate/spec.html to do so and have been able to create ...

When I update the swagger to swagger2 to with my spring boot it stopped showing correct parameters for pageable type when it should show page and size instead it started showing pageSize and pageNu...

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 desc...

I define a path that takes MyObject as a parameter. MyObject has properties for cats and dogs. These have default values. In swagger-editor, the example doesn't show the default values, but try-it-...

I am using swagger 2.0 in a Spring boot(version 1.5.9.RELEASE) project. Swagger works fine but now documentation have hundreds of api and I want to redirect documentation on different different url...

As shown in the image, it says "Response Class (Status 200)" for the add operation. However, the add operation has been implemented in such a way that it will never return 200. It returns 201 on su...

I'm trying to integrate swagger 2.0 with Spring Boot. Whenever I am going to hit to any Controller class API such as (POST,GET,DELETE,PUT). I am getting "Could not resolve reference because of: Co...

I have the following schema definition: swagger: '2.0' ... definitions: Service: type: object properties: serviceId: type: string description: Device or service identification number exampl...