When debugging I was using the debug config (Which I had generated XmlComments for: Properties -> build tab -> Output -> XML Documentation File) I had not done this for my release configuration (duh…) – now everything works
Got this working in the end by trial and error. This is the code that works for me: c.AddSecurityDefinition(“Bearer”, new OpenApiSecurityScheme { Description = “JWT Authorization header using the Bearer scheme. \r\n\r\n Enter ‘Bearer’ [space] and then your token in the text input below.\r\n\r\nExample: \”Bearer 12345abcdef\””, Name = “Authorization”, In = ParameterLocation.Header, Type = SecuritySchemeType.ApiKey, … Read more
To start with, the HTTP OPTIONS, in CORS, is a preflight request that is automatically issued by the browser, before the actual request—is not the one that returns the File response. It requests the permitted communication options for a given server, and the server responds with an Access-Control-Allow-Methods header including a set of permitted methods … Read more
You can’t describe query parameters as part of the path in Swagger. You have to declare those explicitly as query parameters. “/v1/products”:{ “get”:{ “tags”:[ “Search Text” ], “summary”:”Get Products by searching text, countrycode, page number, pagesize, project and country(optional)”, “description”:”Get Products by searching text, countrycode, page number, pagesize, project and country(optional)”, “operationId”:”getProductName”, “produces”:[ “application/json”, “application/xml” … Read more
ApiKeyScheme was deprecated, in version 5 you can use like this: services.AddSwaggerGen(c => { c.SwaggerDoc(“v1”, new Info { Title = “You api title”, Version = “v1” }); c.AddSecurityDefinition(“Bearer”, new OpenApiSecurityScheme { Description = @”JWT Authorization header using the Bearer scheme. \r\n\r\n Enter ‘Bearer’ [space] and then your token in the text input below. \r\n\r\nExample: ‘Bearer … Read more
Indeed, the example you give here is invalid because $ref can’t co-exist with other properties in the same object. $ref is a JSON Reference, and by definition, will cause the other properties to be ignored. From your question, I assume you’re looking for basic composition (rather than inheritance). This is achievable using the allOf keyword. … Read more
This is not supported as of OpenAPI 3.1, and I have to resort to a workaround. If I have a path /tags{tag_path} and I enter something like this as tag_path: /foo/bar, then the actual query request URL will be: /tags%2Ffoo%2Fbar. So, I just added support for that on my backend: the endpoint handler for /tags* … Read more
I don’t think you can use “object” as query parameter in Swagger spec as query parameter only supports primitive type (https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types)
The answer depends on whether you have a plain web page you edit directly, or use a framework like Node.js or React. For simplicity, I’ll assume the former. Download (or clone) the Swagger UI repository. You’ll need the following files from the dist folder: swagger-ui.css swagger-ui-bundle.js swagger-ui-standalone-preset.js In the <head> section of your web page, … Read more
Handy way: Using Browser Printing/Preview Hide editor pane Print Preview (I used firefox, others also fine) Change its page setup and print to pdf