Warm tip: This article is reproduced from serverfault.com, please click
c# swagger swashbuckle swagger-ui

Is there a way change the Controller's name in the swagger-ui page?

发布于 2016-05-06 15:29:14

I'm using Swashbuckle to enable the use of swagger and swagger-ui in my WebApi project.

In the following image you can see two of my controllers shown in the swagger-ui page. These are named as they are in the C# code, however I was wondering if there was a way to change what is shown here?

This is mainly because as you can see ManagementDashboardWidget is not a user friendly name, so I want to change it to be user friendly.

swagger-ui

Questioner
XN16
Viewed
0
分享
venerik 2016-05-09 20:06:15

You can use tags for that. By default Swashbuckle adds a tag with the name of the controller to every operation. You can override that with the SwaggerOperationAttribute. For instance, the next line replaces the default tag, Values, with the tag Test:

public class ValuesController : ApiController
{
    [SwaggerOperation(Tags = new[] { "Test" })]
    public IHttpActionResult Get()
    {
        // ...
    }
}

The Getoperation will now be put in the group Test.

If you want the operation to appear in multiple groups you can add more tags. For instance:

[SwaggerOperation(Tags = new[] { "Test", "Release1" })]

will put the Get operation in the groups Test and Release1.

XN16 2016-05-09 15:36:04

That's exactly what I wanted... I just never found much documentation on that part. Thanks very much.

jtate 2019-04-18 15:54:01

This works, but it still leaves the controller name as a tag in the UI, but with no actions under it. For example, say I have ABCController but I've added [SwaggerOperation(Tags = new[] { "DEF" })] to all routes, the UI shows "ABC" and "DEF", but there is nothing under "ABC". How do we get rid of "ABC" altogether?

Diego Baranowski 2021-01-16 00:04:31

Take a look to my answer below. I hope it helps you!

热门帖子

1
iOS 17.5 BUG 有用户发现多年前删除的照片重新出现在照片库
2
怎么 vision pro 没啥讨论度了
3
卷死同行 gpt-4o 模型 1.4 折中转 接近官网 3.5 的价格！
4
新房入住， 618 有推荐的组 MESH 的主副路由器吗？
5
各位大佬好，我是一名大学生，想请教一下大家有没有什么适合大学生的赚钱小项目？我深知赚钱不易，所以想在不影响学业的前提下，找一些小项目来赚点零花钱。希望各位大佬能不吝赐教，分享一些你们的经验和建议。谢谢大家啦！
6
虚心求教，数据量上亿的爬虫数据用什么该用什么数据库呢
7
联通推出了更便宜的 eSIM iPad 套餐
8
坐标深圳，收台主机，不急
9
google doc如何快速插入日期时间？
10
最近三年面了三百多人，给程序员和面试官们分享一下我的感受

热门github

1
Implementation of paper - YOLOv9: Learning What You Want to Learn Using Programmable Gradient Information
2
A Windows and Office activator using HWID / Ohook / KMS38 / Online KMS activation methods, with a focus on open-source code and fewer antivirus detections.
3
Get up and running with Llama 2, Mistral, Gemma, and other large language models.
4
该项目可以让你通过订阅的方式使用Cloudflare WARP+，自动获取流量。This project enables you to use Cloudflare WARP+ through subscription, automatically acquiring traffic.
5
Multi functional app to find duplicates, empty folders, similar images etc.
6
Xray panel supporting multi-protocol multi-user expire day & traffic & ip limit (Vmess & Vless & Trojan & ShadowSocks & Wireguard)
7
The Free Software Media System
8
lightweight, standalone C++ inference engine for Google's Gemma models.
9
📚 Freely available programming books
10
A collective list of free APIs
11
1️⃣🐝🏎️ The One Billion Row Challenge -- A fun exploration of how quickly 1B rows from a text file can be aggregated with Java
12
🎓 Path to a free self-taught education in Computer Science!
13
Curso para aprender el lenguaje de programación Python desde cero y para principiantes. 75 clases, 37 horas en vídeo, código, proyectos y grupo de chat. Fundamentos, frontend, backend, testing, IA...
14
This repository contains System Design resources which are useful while preparing for interviews and learning Distributed Systems
15
Mamba is a new state space model architecture showing promising performance on information-dense data such as language modeling, where previous subquadratic models fall short of Transformers. It is based on the line of progress on structured state space models, with an efficient hardware-aware design and implementation in the spirit of FlashAttention.