Category "swagger"

springdoc-openapi-ui swagger 3 change API description

I am new to String and Swagger 3. How can I change the default API description i.e. OpenAPI definition in Swagger springdoc-openapi-ui swagger 3 Also version,

springdoc-openapi-ui swagger 3 change API description

I am new to String and Swagger 3. How can I change the default API description i.e. OpenAPI definition in Swagger springdoc-openapi-ui swagger 3 Also version,

How to migrate Springfox' @Api to Springdoc's @Tag?

Manual just says replace @Api -> @Tag. But @Api has produces and consumes parameters, while @Tag has obligatory name parameter. How to migrate @Api(produces

Automatic OpenAPI YAML generation

I am working on the backend of a Spring Boot application that uses OpenAPI and Swagger to provide the interface for frontend application via an schema.yml file.

Getting 405 error in OpenAPI swagger page if I put only path variable attributes in a Rest Controller

I am trying to create Swagger documentation using OpenAPI 3.0. I am using spring-boot-starter 1.5.4.RELEASE and springdoc-openapi-ui version 1.4.2 <parent>

How to serialize enum as string in Function App running on .net5 with OpenAPI/Swagger?

I am exploring Function App running on .net5 in the new isolated mode. I have HTTP triggered functions that I want to advertise via OpenAPI / Swagger. To do so,

How to disable "django login" hyperlink while accessing swagger ui in drf-yasg?

I'm using drf-yasg to add swagger auto schema to my endpoints. The swagger-ui is being visible at /api/v1/swagger/ At my local setup this link is working fine a

Exact purpose of tags in OpenAPI and why are they unique

By Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md A list of tags used by the specification with additional metadata

How to add summary and body manually in swagger nestjs

I am trying to add summary in my swagger documentation routes but I am not able to find the appropriate decorator for defining the summary. There are some rout

How to solve Spring swagger Ambiguous mapping?

In my spring controller class i have below two methods @GetMapping(value = "/published_messages", produces = MediaType.APPLICATION_JSON_VALUE) public Respo

404 error with swagger-ui and spring webflux

I am developping REST services with Spring Webflux and I want to produce documentation with Swagger2 for my API with. I discovered that Webflux is only supporte

401 unauthorized page for swagger?

I am enable swagger2 by @EnableSwagger2. However, when I try to hit "/swagger-ui.html", it first hit my Authentication Filter. Then, I wrote the following code

django_rest_swagger - 'staticfiles' is not a registered tag library. Must be one of:

Have this error while trying to autogenerate API docs for django rest framework in django 2.2.4, from what I'm seeing in the logs it has something to do wi

django_rest_swagger - 'staticfiles' is not a registered tag library. Must be one of:

Have this error while trying to autogenerate API docs for django rest framework in django 2.2.4, from what I'm seeing in the logs it has something to do wi

Swagger declaration schema = @Schema(implementation = Map.class) represents Schema as String in swagger-ui

I am trying to create springdoc swagger documentation, and I would like to represent a request body having data type Map<String, Object> in a better reada

How to define in swagger spec either of two properties are not null and required

I have a requirement to have two properties in the payload say property1 and propert2. Both are array type. Condition is, that either both can have values, or o

Ask for credentials before showing my swagger

I'm trying to add security to my API swagger endpont. I have created my API using node.js and express and swagger-ui-express module. The problem is that anyone

Nodejs Swagger unable to add authorization header to requests

I am trying to add an authorization header to Swagger UI using Node.js Express server. Requests need to have x-auth-token as one of the headers for the API to g

What does 'required' in OpenAPI really mean

Given the following OpenAPI definition Person: required: - id type: object properties: id: type: string Which of the below objects are val

How to define a header parameter's default value is in OpenAPI 3.0

I have an endpoint that accepts a PUT without a body. The PUT causes an event to trigger on the backend, and our API design team decided that PUT was the best R