Category "swagger"

How to load all the examples in to the @ExampleObject without specifying the ref so its visible in SwaggerUI?

I am developing a simple application where I would like to read the files from a remote URL and add them to the @ExampleObject. I am able to achieve this using

Gitlab failed pipeline when merging yaml file

I'm trying to merge a yaml file containing 7000 lines of swagger documentation into gitlab but the pipeline keeps failing. The failure is happening because ther

How can generate a swagger from my spring boot application?

I have created a web rest API using Spring boot and I would like to generate a swagger page with the APIs documentation. How can I do that?

how to move Javascript created DIV to bottom of page

I have swagger ui HTML page. there is generating HTML tags and divs with javascript so I want to move this whole description div to the bottom of the page. but

Swagger-ui-express swagger-JsDoc error 😱 Could not render n, see the console. in NodeJS app

I have a NodeJs app using swagger-ui-express swaggerJsDoc. When expand schemas as swagger define encountered error below. What should I do ? Error server.js swa

OpenAPI throws Could not resolve reference: Could not resolve pointer: for @ExampleObject files

I am developing a Quarkus service-based application for which I am adding open API based annotations such as @ExampleObject. For this, I would like to add the r

OpenAPI is missing schemas for some of the Pydantic models in FastAPI app

I am building a FastAPI application, which has a lot of Pydantic models. Even though the application is working just fine, as expected the OpenAPI (Swagger UI)

openapi.yaml not generated successfully - Swagger Doc does not open for Windows machines

So I am working on a spring-mvc project, which suddenly started giving this issue when installed on Windows machines only. It's a thick client app. When trying

Create XML documentation file in VS 2022:s User Interface

Goal: Create XML documentation file with VS 2022 as the same in the picture below. The XML should be used for Swagger. Problem: It works in 2019 but I cannot fi

Why are SwaggerResponse and SwaggerResponseExample complaining about HttpStatusCode?

Every example of SwaggerResponse and SwaggerResponseExample I found uses HttpStatusCode as is, but when I use it like this: [SwaggerResponse(HttpStatusCode.BadR

How to specify defaults for SwaggerResponse and SwaggerResponseExample?

Is there a way to specify the default response example in Swagger similar to the ProducesDefaultResponseType like this: [ProducesDefaultResponseType(typeof(Prob

Swagger yaml response html

I need to format my response (examples) in swagger, at the moment I have this but it doesn't work: /** * @swagger * /instance/status: * post: * securi

Outlook Calendar .Net Core Web API GetList (tokenCredential parameter cannot be null. (Parameter 'tokenCredential'))

I have an API project related to Outlook calendar integration. With this project, you can access your outlook account. I want to list all the events in the cale

FastAPI swagger don't use custom header

I want to add "Authorization" header to the my FastAPI application. I did it by documentation, but when i try to execute request in the swagger - it doesn't wor

NestJs Swagger: How to define Api Property for dynamic classes

I have below class export class DocumentsSteps { @ApiProperty({type: ???}) [type: string]: DocumentStep; } How should I define ApiProperty type?

drf_yasg.generators: path component of api base URL http://localhost:8080/ is ignored; use FORCE_SCRIPT_NAME instead

I am using swagger (drf_yasg.generators) with Django and I get the following error message Error message is drf_yasg.generators: path component of api base UR

How to add Bearer {JWT} in swagger django?

when I authorize myself in Swagger UI, I have to write "Bearer {then I write JWT} here" How can I add the string "Bearer" automatically before the JWT token in

Swagger OpenAPI UI sending 403 response status for POST, PUT and DELETE Requests

Issue : Get request for Swagger UI openAPI is working , whereas other method types giving 403 error. Dependency : <dependency> <groupId>org.

How to provide completely custom JSON for example in Swagger?

I have Java endpoint which receives json-deserializable object. Unfortunately, Swagger is unable to auto-generate good example for it. Is it possible to provide

Create a custom response in Swagger Nestjs

I have my controller with @Post('email/register') @HttpCode(HttpStatus.CREATED) @ApiOkResponse(AuthConfigSwagger.API_OP_CREATE) @ApiCreatedResponse(Auth