Category "swagger"

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

How to declare Nullable response types in SwashBuckle (generating clients in NSwagStudio)

We use SwashBuckle to configure our AspNet Core (Service fabric) project to generate Swagger json and UI. Then we use NSwagStudio to generate typescript and C#

Can I generate an Open API 3 Python Flask server?

From http://editor.swagger.io/ with swagger 2.0 I am able to select: Generate Server-->python-flask and generate a python server that I can deploy and use.

Swagger-ui keeps showing example petstore instead of provided swagger.json

I followed instructions to set up swagger documentation for my existing node API using swagger-jsdoc. The swagger.json is being served correctly and I added a p

How to document default None/null in OpenAPI/Swagger using FastAPI?

Using a ORM, I want to do a POST request letting some fields with a null value, which will be translated in the database for the default value specified there.

Document QueryDSL endpoint with Swagger

I'm using Spring Boot Data, QueryDSL and Swagger. I've define endpoint like this: @GetMapping public ResponseEntity<?> listOfThings( @PageableDef

InvalidOperationException: Can't use schemaId .. The same schemaId is already used for type

I receive the following error. InvalidOperationException: Can't use schemaId "$Registration" for type "$PortalService.Models.Registration". The same schemaId is

Swagger Codegen generates nested Lists by using array as response for spring server stub

I am using the cloud SwaggerHub Codegen Editor and wrote API like this: /foodlogs: get: tags: - foodlog summary: searches food logs operationId: searc

Springfox 3.0.0 is not working with Spring Boot 2.6.0 [duplicate]

Springfox 3.0.0 is not working with Spring Boot 2.6.0, after upgrading I am getting the following error org.springframework.context.Applicatio