.NET Core 7极简API如何为OpenAPI标签组添加描述?
给API分组标签添加描述的方法
Swagger/OpenAPI(OpenAPI 3.x)
如果你的API文档基于OpenAPI规范,直接在配置的tags字段中为每个分组标签添加description属性即可,示例如下:
openapi: 3.0.3 info: title: 你的API文档 version: 1.0.0 tags: - name: MCP Provider description: 负责对接传统MCP服务的API集合,涵盖资源查询、配置更新、状态同步等核心操作 - name: Nexgen Provider description: 面向下一代云原生架构的API端点集合,支持高并发请求、分布式资源调度等场景 paths: # 你的具体API端点定义...
配置完成后,在Swagger UI中点击或悬停对应标签时,就会显示你填写的描述内容。
Postman
如果是在Postman中管理API分组:
- 在左侧面板找到「MCP Provider」分组,右键点击选择「Edit Folder」
- 在弹出的编辑窗口里,找到「Description」输入框,填写该分组的详细描述
- 用同样的方式编辑「Nexgen Provider」分组,保存后即可在分组详情页查看描述
其他API文档工具(如Redoc、Stoplight)
这类工具的核心逻辑一致:找到分组标签的编辑入口,在配置项中添加描述文本即可。通常在分组的设置面板里,会有专门的输入框用于填写标签描述,按界面提示操作即可完成配置。
内容的提问来源于stack exchange,提问作者Terry
相关产品推荐
相关产品推荐

