I'm trying to create a swagger doc for below JSON, but I'm getting the below error: schemas with 'type: array', require a sibling 'items: ' field JSON: { "_id": "string", "name": "string", "de...

How do I annotate my ASP.NET WebAPI actions so that the swagger metadata includes the content-types that my resources support? Specifically, I want the documentation to show that one of my resourc...

I am defining an API and I have a field that is called "payload". We had this field defined as "type": string in our swagger however those payload data begun to have structure. More particula...

I have created a Spring Boot 2 Application, integrated SpringFox Swagger 2.8.0 with Implicit Oauth2 Grant for Authentication and Authorization. The Code is working fine but when I click Authorize ...

Right now my OpenAPI 2.0 YAML file has only one host URL: host: petstore.test.com basePath: / Can I use multiple hosts like this? host1: petstore.test.com host2: petstore1.test.com host3: petstore...

I'm writing a Swagger specification for an future public API that requires a very detailed and clean documentation. Is there a way to reference/link/point to another endpoint at some other location...

I have simple REST services implemented with Spring MVC. I decided to describe them with Springfox and Swagger 2.0. Everything seemed to be OK until I started adding security schemas and contexts. ...

I am trying to use Swagger to define an API that accepts an actual file and a schema object that describes the contents of a file. Here is a snippet of the Swagger YAML. However it won't validate i...

In the latest version on Django REST Swagger (2.1.0) YAML docstrings have been deprecated. I cannot get swagger to show the POST request parameters. Here is my view class UserAuthenticationView(A...

I've been given some JSON files generated by a REST API with plenty of properties. I've created a Swagger 2.0 definition for this API and need to give it the corresponding schema for the response....

I'm using swagger 2.0 to define my API. I'm using enums as described in the docs here. I have the following endpoint in my swagger.yml file: /my-endpoint: x-swagger-router-controller: my-controll...

I am using Swagger Core 2.0.2 for Java to generate an OpenAPI documentation. Among others, I have the following class SomeDTO: @Schema(name = "SomeDTO", description = "some description") public cl...

I'm writing my swagger definition in yaml. Say I have a definition that looks something like this. paths: /payloads: post: summary: create a payload ... parameters: - in: body name: payload...

I am using Swagger 2.0 for documentation generation. In my controller class, I have some operations like: public Page<Employee> getEmployees(Pageable pageable) {....} Swagger document genera...

I have created Ngnix-Consul Docker setup referred https://github.com/nginxinc/NGINX-Demos/tree/master/consul-template-demo. And have created many microservices. So All the microservices are access...

I am writing an OpenAPI (Swagger) definition where a query parameter can take none, or N values, like this: /path?sort=field1,field2 How can I write this in OpenAPI YAML? I tried the following,...

Is it possible to declare a custom response header which would be present in all responses without copying it in each of the response structure?

I am not able to get my Swagger UI to work with my project. Swagger UI comes up fine but it does not list any of my REST controllers. I am using SPRING 4.2.6.RELEASE and Swagger 2.5.0 . My rest se...

I have code that correctly validates an article returned from an endpoint that returns single articles. I'm pretty sure it's working correctly as it gives a validation error when I deliberately don...

Generated Nodejs code using editor.swagger and in body I want to send 10mb but unable to send, I'm getting this error: Error: request entity too large at makeError (c:\apigee\dojo\nodeServer_2\no...

When working with Swagger Annotations it is not possible to create an example for the request body. Here comes the annotation stuff for the RESTful resource/endpoint: @POST @Path("/{carId}/con...

I have a REST services to document, some of them accepts simple array like: [ { "name":"a" }, { "name":"b" }, { "name":"c" } ] How do I describe this in Swagger model section ? I can only cre...

I've created rest API in lumen using This wrapper for which I'm using google hidden reCaptcha on my web panel but I wanted to know if I can implement it on swagger too?

I am developing a REST API. during development I have used postman (chrome extension) to use and document my API. It is a wonderful tool and I have most of my API endpoints in it. However, a...

I like Swagger because it makes your apis very user friendly. I use Swagger annotations like @ApiParam @ApiResponse | @ApiResponses @ApiOperation Others On endpoints, query params, request ...