Skip to main content
12,424 questions
Newest Active Bountied Unanswered
Filter by
Sorted by
Tagged with
310 votes
16 answers
232k views

I have a C# ASP.NET WebAPI application with API documentation being automatically generated using Swashbuckle. I want to be able to omit certain methods from the documentation but I can't seem to ...
payetools-steve's user avatar
  • 4,080
203 votes
1 answer
233k views

I have JSON schema file where one of the properties is defined as either string or null: "type":["string", "null"] When converted to YAML (for use with OpenAPI/Swagger), it becomes: type: - 'null' ...
Vaibhav Patil's user avatar
  • 3,091
178 votes
6 answers
393k views

What is the correct way to declare a date in a swagger-file object? I would think it is: startDate: type: string description: Start date example: "2017-01-01" format: date ...
Patrick Savalle's user avatar
  • 4,496
154 votes
37 answers
351k views

I develop an ASP.NET Core 2 application and included Swagger. Everything worked fine until I introduced a method without explicitly defining the HTTP action: public class ErrorController : Controller {...
Ash's user avatar
  • 3,663
140 votes
16 answers
309k views

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 ...
shubhendu_shekhar's user avatar
  • 1,433
128 votes
13 answers
234k views

For some REST APIs written in PHP, I was asked to create Swagger documentation, and since I was not aware of any easy way of annotating those existing APIs and create such a documentation, I used this ...
Salil's user avatar
  • 1,811
123 votes
3 answers
152k views

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, as we near ...
StuBob's user avatar
  • 1,618
118 votes
15 answers
373k views

I have added Swagger to my Spring Boot 2 application: This is my Swagger config: @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { // @...
alexanoid's user avatar
  • 26.1k
112 votes
2 answers
76k views

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 ...
brandonscript's user avatar
  • 73.7k
103 votes
23 answers
204k views

Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2....
Paddy Popeye's user avatar
  • 2,244
100 votes
20 answers
256k views

I'm trying to open my self generated swagger specification file my.json with swagger-ui on my local computer. So I downloaded the latest tag v2.1.8-M1 and extracted the zip. Then I went inside the ...
Adam Taras's user avatar
  • 1,513
96 votes
9 answers
63k views

I receive the following error. InvalidOperationException: Can't use schemaId "$Registration" for type "$PortalService.Models.Registration". The same schemaId is already used for ...
John Bowyer's user avatar
  • 1,503
95 votes
7 answers
141k views

I have Swagger API Declaration for services using Swagger v 1.2. My original feeling about Swagger was that it is very close to JSON Schema (Draft 3 and lately Draft 4) and it shall be relatively easy ...
Jan Vlcinsky's user avatar
  • 44.4k
93 votes
12 answers
109k views

Is there a method for creating static documentation for swagger 2.0? Perhaps like the 'preview' on editor.swagger.io. I need to get static html files so I can include them in some static documents. ...
romeovs's user avatar
  • 6,013
90 votes
12 answers
185k views

I searched for possible ways to add a request header parameter that would be added automatically to every method in my web-api but I couldn't find a clear one. While searching I found that the method ...
user avatar
89 votes
5 answers
86k views

I have a swagger 2.0 resource defined below. How can I make "param1 or param2" required? Caller has to pass either param1 or param2. /some/res: put: summary: some resource responses: 200: ...
Vineet Bhatia's user avatar
  • 2,533
88 votes
3 answers
106k views

I have a ReSTFul API written in simple Spring (no Spring Boot, no fancy stuff!). I need to implement Swagger into this. So far, EVERY page on the internet has only driven me crazy with confusing ...
wavicle's user avatar
  • 1,304
82 votes
7 answers
227k views

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 ...
razor's user avatar
  • 2,897
81 votes
5 answers
101k views

I created an API spec from some JSON files and I am trying to test if the files validate against the API spec. There are some good tools to validate against JSON Schema, but I did not have chance to ...
Peter G.'s user avatar
  • 8,094
78 votes
10 answers
81k views

Implementing Swashbuckle/Swagger with .net Core 2 API I am now receiving the 500 error when accessing swagger.json: NotSupportedException: Ambiguous HTTP method for action - EBisAPI.Controllers....
sammarcow's user avatar
  • 2,976
74 votes
7 answers
74k views

I am developing some Web API with .NET Core 3.0 and want to integrate it with SwashBuckle.Swagger. It is working fine, but when I add JWT authentication, it does not work as I expect. To do that, I ...
Nick Mehrdad Babaki's user avatar
  • 12.7k
71 votes
6 answers
68k views

I like swagger for documenting Restful APIs very much, especially "Try it out!" button, but swagger-ui interface doesn't look very cool. And I cannot believe there are no templates for such amazing ...
Arūnas Smaliukas's user avatar
  • 3,321
69 votes
10 answers
93k views

I have 2 HTTP GET method in same controller and give me this error HTTP method "GET" & path "api/DataStore" overloaded by actions - DPK.HostApi.Controllers.DataStoreController.GetByIdAsync (DPK....
user avatar
67 votes
1 answer
108k views

I have some API definitions in OpenAPI 2.0 format, but my tooling requires OpenAPI 3.0 format. How do I convert OpenAPI 2.0 to OpenAPI 3.0? Ideally I want to be able to script the process to avoid ...
Rumesh Madhusanka's user avatar
  • 1,465
64 votes
2 answers
97k views

Although I have seen the examples in the OpenAPI spec: type: object additionalProperties: $ref: '#/definitions/ComplexModel' it isn't obvious to me why the use of additionalProperties is the ...
Chen Levy's user avatar
  • 16.6k

1
2 3 4 5
…
249