question-mark
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.

Hide Empty Controller API Tag

See original GitHub issue
  • What version of the library are you using? 2.9.2

What kind of issue is this?

  • Feature Request

I’ve found a very useful way to section off certain endpoints in a controller by using tags above each endpoint inside the @ApiOperation annotation: @ApiOperation(value = xxx, tags = {"Endpoint List 1"})

However, I notice when I do this to every method in my Controller, there is still the original base API section of the entire controller, and it is empty when expanding it since I have sectioned each method into their own tagged groups.

Can a feature be added to hide empty groupings on swagger-ui.html? Does this already exist and I’m missing it?

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:4
  • Comments:15 (2 by maintainers)

github_iconTop GitHub Comments

7reactions
naineshmpcommented, Feb 17, 2021

@dilipkrish - I am having similar issue, where empty controllers tags are showing up. I could not find any specific solution. Just wanted to check if you recommend any solution.

6reactions
DirkHeijnencommented, May 20, 2019

Please take a look at this issue again, there is still no solution for this as of today.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to hide empty groups in swagger? - java - Stack Overflow
The change to make is: Do a fork and clone the code. Locate the file: modules / openapi-generator / src / main /...
Read more >
Hiding Endpoints From Swagger Documentation in Spring Boot
Let's have a look at how we can hide endpoints from Swagger API documentation.
Read more >
Hide actions from Swagger / OpenAPI documentation in ASP ...
This way that particular controller's actions are hidden. You can use any logic you want to decide whether an action should be visible....
Read more >
How To Hide Empty Groups In Swagger - ADocLib
While creating Swagger documentation, we often need to hide endpoints from being exposed to ... Ask questionsHide Empty Controller API Tag.
Read more >
Paths and Operations - Swagger
API paths and operations are defined in the global paths section of the API ... paths: /users/{id}:; get: tags: - Users; summary: Gets...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found