How to hide the Models section in Swagger UI?

Question

I use Swagger UI to display API documentation. By default, it displays the "Models" section at the bottom:

How to hide it?

Hope this answer help those who are working with Java: https://stackoverflow.com/a/70633900/17839111 — Julio Toledo, Jul 12 '22 at 10:13

Helen · Accepted Answer · 2020-03-04T08:49:05.953

26

To hide the "Models" section, add defaultModelsExpandDepth: -1 to the Swagger UI configuration code in your index.html.

Note the option name uses plural Model*s* not Model.

// index.html

<script>
window.onload = function() {
  // Begin Swagger UI call region
  const ui = SwaggerUIBundle({
    url: "https://petstore.swagger.io/v2/swagger.json",
    dom_id: '#swagger-ui',
    defaultModelsExpandDepth: -1,   // <-------

Swagger UI also has many other configuration options that control API documentation rendering.

edited Mar 04 '20 at 08:49

answered Jul 22 '19 at 11:00

Helen

87,344
17
243
314

how can i do it using nelmio_api_doc.yml? – samar Aug 07 '19 at 13:59
@samar please [ask a new question](/questions/ask). – Helen Aug 07 '19 at 14:35

score 17 · Answer 2 · answered Aug 25 '20 at 00:32

For .Net Core 3.0 just Add c.DefaultModelsExpandDepth(-1); on your Startup.cs

// Startup.cs

app.UseSwaggerUI(c =>
{
    c.DefaultModelsExpandDepth(-1); // Disable swagger schemas at bottom
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API V1");
});

score 5 · Answer 3 · edited May 15 '20 at 21:39

5

In Docket bean just add new

Docket(DocumentationType.SWAGGER_2).ignoredParameterTypes(YourClass.class,YourAnother.class)

I hope its helpful

edited May 15 '20 at 21:39

Jaimil Patel

1,301
6
13

answered May 15 '20 at 00:38

ImI

198
1
8

score 2 · Answer 4 · answered Apr 07 '23 at 02:52

2

Using Spring Boot:

@Bean
public UiConfiguration uiConfiguration() {
    return UiConfigurationBuilder//
            .builder()//
            .defaultModelsExpandDepth(-1)//
            .build();//
}

answered Apr 07 '23 at 02:52

Luciano Ortiz

31
2

Short and sweet answer. It helped me. Thanks for sharing. – Ajay Kumar Aug 17 '23 at 16:25

score 1 · Answer 5 · answered Dec 08 '20 at 13:07

1

If using Django add this inside your settings.py:

SWAGGER_SETTINGS = {
    'DEFAULT_MODEL_DEPTH':-1
}

answered Dec 08 '20 at 13:07

PSN

2,326
3
27
52

score -2 · Answer 6 · answered Feb 21 '20 at 15:52

Although not the exact results you are looking for but i find it perfect to just disable the properties of the model you don't want via:

<?php
// src/AppBundle/Entity/User.php

use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Serializer\Annotation\Groups;

...

 * @ApiResource(
 *     attributes={
 *         "normalization_context"={"groups"={"api"}},
 *         "denormalization_context"={"groups"={"api"}}
 *     },

...

 */
class User extends BaseUser
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     * @Groups({"api","user:read"})
     */
    protected $id;

    /**
     * @var \DateTime
     */
    private $disabledProperty;

This way you will get a model just with the props you exposed via the group api. Hope this helps someone :)

That's what I mentioned in the first sentence of my answer! But the end result is the same as what the original question was looking for :) — numediaweb, Mar 05 '20 at 13:55

How to hide the Models section in Swagger UI?

6 Answers6

Linked