Category "swagger-ui"

How to Customise example value of request body and execute it on swagger-ui with springdoc-open-api

I have created rest webservice using springboot and added springdoc-open-api for ducumentation of webservice, Now i have 2 question 1-how to add custom test val

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 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 Integrate Open API 3 with Spring project (not Spring Boot) using springdoc-openapi

My Existing Project is on Spring Framework not Spring Boot. I want to integrate Open API 3 with it. I want to integrate using springdoc-openapi not using Jers

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

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

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

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

SpringDoc openAPI tool not scanning for APIs in Spring Boot Project

I'm having trouble getting this to work. I've started with a working SpringBoot (v2.2.2) app with a working @RestController. To get springdoc to work I've inclu

How to remove controller list from Swagger UI

I'm using springfox-swagger-ui 2.8.0 which ships with Swagger UI 3.7.0. I want to get rid of the controller list in front of the api documentation page, pretty

Springfox swagger-ui.html unable to infer base URL - Caused by missing cookies

We have our Spring Boot services behind an API Gateway. With an earlier version of Springfox - 2.1.2 we had no issues in loading the swagger-ui.html page. This

Specify example requests for swagger's "Try it out"

Is there a way to specify example requests for swagger? Maybe even multiple ones? The Try it out button shows only generic values like: { "firstName": "s

Swagger not loading - Failed to load API definition: Fetch error undefined

Trying to setup swagger in conjunction with a web application hosted on IIS express. API is built using ASP Net Core. I have followed the instructions prescribe

Different DocInclusionPredicate for different swagger document with Swashbuckle.AspNetCore

I'm trying to generate multiple swagger.json documents and using Customize the Action Selection Process to determine which action goes to which swagger document

Unable to infer base url... springfox-swagger2 version 2.9.2

Version of springfox-swagger that I am using [ ![Download] 1]2 What kind of issue is this? Project structure: SwaggerConfig is in automate.api.config.swagger.Sw

swagger-ui No mapping found for HTTP request

I'm trying to document and existing Rest API a Spring MVC project (NOT spring boot!). My application is called api so http://localhost:9090/api would be the r

enum of objects in swagger UI?

I have an enum of other definitions in my Swagger spec: "action": { "title": "Action", "description": "Action to apply to matching requests", "type": "ob

How to use swagger_auto_schema in a class based view with no serializer_class and how to add custom authentication permission to it?

I have a class based view as: class ClassBasedView(GenericAPIView): @swagger_auto_schema(responses={201: 'Created'}) @authorize(myCustomPermission)

Is there a way change the Controller's name in the swagger-ui page?

I'm using Swashbuckle to enable the use of swagger and swagger-ui in my WebApi project. In the following image you can see two of my controllers shown in the s