My Application is Sping MVC not boot. I'm using springdoc-openapi-ui 1.4.4 also, I added the following imports to one of my @configuration class; org.springdoc.core.SpringDocConfigProperties.class...

I'm working in a REST service made with spring-boot, which to this day is documented using springfox-swagger2:2.7.0 (implementation first). The last operation I've added looks like this: @ApiOpera...

I am trying to add a read-only field for 'House' in this example. The house is another model that I want to be read-only. In this example, the array of Dogs can be set to readOnly without an erro...

Is there a way to describe a json-lines with OpenAPI? Besides the fact that there seems to be no MIME type for it yet, I'm wondering if it's possible to describe such a response. In theory my respo...

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 included the following dependency in my po...

I have three path variables for an API. I want to mask one input on Swagger UI with *****. How can I do this when using Springdoc OpenAPI?

I'm trying to hide the entire schemas section of the FastAPI generated swagger docs. I've checked the docs and tried this but the schema section still shows. @Schema(hidden=True) class theSchema(...

I have written an web service definition as an OpenAPI document. The openapi-generator-maven-plugin I'm using always generates a whole project with poms and gradle build scripts, but I only need th...

I noticed that in OpenAPI Path Items and some other constructs you have both summary and description fields, what is the difference between those, and what is the purpose of each? For me, they seem...

I have a Django project and I am using Django REST framework. I am using drf-spectacular for OpenAPI representation, but I think my problem is not tied to this package, it's seems a more generic Op...

I try to follow these: https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ How do I deal with annotations like: @ApiModel(value = "Response contain...

I am adding swagger UI to my Spring boot application. When I try to access the swagger-ui.html. I get the 404 error. Config class : @Configuration public class SwaggerConfig { @Bean public OpenA...

I have a .NET 5 API using OpenApi. Is it possible to hide all API endpoints in swagger but the login one until user is authorized with a JWT Bearer Token? This is the code I use in startup.cs servi...

I am unable to get OpenAPI spec Swagger "external refs" to work because Swagger rendering gives me an exception. I must have this to make editing giant swagger documents more manageable s...

I just started working on Swagger 2.0 API recently. I am looking for some ways to organize the API documentation. Currently I'm using the @Api(tags = {"Heading1"}) Java annotation to tag ...

How to I define in OpenAPI/Swagger if a field is optional or required and what is the default?

I'm using Swagger as documentation of my API so that others can use this to build other services reliant on this. I would like to still show the endpoints that are not implemented yet on the UI so ...

How to enable "Authorize" button in springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) for Bearer Token Authentication, for example JWT. What annotations have to be added to Spring @Controller an...

Let's assume I have this definition in my openapi.yml (this is just a madeup example to depict the issue I have): components: schemas: Address: type: object properties: name: type: string zi...

How to specify a property as null or a reference? discusses how to specify a property as null or a reference using jsonschema. I'm looking to do the same thing with swagger. To recap the answer to ...

I upgraded to Spring boot 3.0.7 and am trying to get my Open API (swagger) working again, with these dependencies (per springdoc): <dependency> <groupId>org.springdoc</groupId> ...

I have the following OpenAPI definition: swagger: "2.0" info: version: 1.0.0 title: Simple API description: A simple API to learn how to write OpenAPI Specification schemes: - https host: no...

I want to use a class from a library as a type of a property. Say it is foo.lib.Foo. What is the right way to properly define it as a type of the property? SomeDto: type: object properties: foo:...

After reading these 2 posts here on Stackoverflow: How to Solved ErrorException : Required @OA\PathItem() not found Can't generate API documentation in l5-swagger I still get an error Required ...

I am integrate the OpenAPI with my project, when I access the url: http://127.0.0.1:11014/swagger-ui/index.html, shows error like this: Unable to render this definition The provided definition does...