Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Question] Is it possible to disable example data generation?

See original GitHub issue

First thanks a lot for springdoc-openapi-ui, it works great out of the box!

Because of some recursion in my data model, the example data Swagger generates is massive [1] and doesn’t render at all in the browser (the tab that loaded the doc page hangs).

Is it possible to disable this generation when springdoc-openapi-ui produces the documentation?

[1] I have discovered this by trying an alternate path:

Run generateOpenApiDocs from org.springdoc.openapi-gradle-plugin
A valid 240KB openapi.json is generated 👍
Run swagger-codegen generate -l html -I openapi.json
A single page HTML doc is generated: it’s > 3MB and is mostly composed of a completely useless example data section.

Issue Analytics

State:
Created 3 years ago
Comments:6 (3 by maintainers)

Top GitHub Comments

2reactions

bnasslahsencommented, Jul 4, 2020

Hi @dandew,

There is no such property, but you can ask for an enhancement on the swagger-ui project:

https://github.com/swagger-api/swagger-ui/issues

Are you using groups (or GroupedOpenApi Bean) ?

1reaction

bnasslahsencommented, Jul 4, 2020

I would guess, it might be more related to the performance of the rendering on the client side.

There are some existing requests to improve the performance of the UI, as for example:

https://github.com/swagger-api/swagger-ui/issues/5779

I am quite sure, if you provide them the relevant information they need, they could help.

Top Results From Across the Web

Disabling tracking data generation for a Process Server ... - IBM

The accepted answer above will stop tracking data generation from all BPDs, regardless of what settings the individual BPDs contain. This action is...

Disable or turn off the auto generation of mappings based on ...

I am using the Code First constructs to connect to an existing database (which, I know is not code first technically). I do...

Enable and Disable change data capture - SQL Server

Disabling the database removes all associated change data capture metadata, including the cdc user and schema and the change data capture jobs.

Disable and suppress inspections | IntelliJ IDEA Documentation

Some inspections may report problems that you currently do not want to see. In this case, you can disable or suppress them.

Offering account deletion in your app - Support

Apps submitted to the App Store that support account creation must also ... only offering to temporarily deactivate or disable an account is...