AspNetCore自定义/显式Swagger操作ID
创始人
2024-09-20 09:31:21
0

要自定义或显式设置Swagger操作ID,可以使用SwaggerOperationAttribute来为每个操作设置唯一的ID。以下是一个示例解决方案,展示了如何使用SwaggerOperationAttribute来自定义Swagger操作ID。

using Microsoft.AspNetCore.Mvc;
using Swashbuckle.AspNetCore.Annotations;

namespace YourNamespace
{
    [Route("api/[controller]")]
    [ApiController]
    public class YourController : ControllerBase
    {
        [HttpGet("{id}")]
        [SwaggerOperation(OperationId = "GetById")]
        public IActionResult GetById(int id)
        {
            // Your logic here
            return Ok();
        }

        [HttpPost]
        [SwaggerOperation(OperationId = "Create")]
        public IActionResult Create([FromBody] YourModel model)
        {
            // Your logic here
            return Ok();
        }

        [HttpPut("{id}")]
        [SwaggerOperation(OperationId = "UpdateById")]
        public IActionResult UpdateById(int id, [FromBody] YourModel model)
        {
            // Your logic here
            return Ok();
        }

        [HttpDelete("{id}")]
        [SwaggerOperation(OperationId = "DeleteById")]
        public IActionResult DeleteById(int id)
        {
            // Your logic here
            return Ok();
        }
    }

    public class YourModel
    {
        // Your model properties here
    }
}

在上述示例中,我们在每个操作上使用SwaggerOperation属性来设置操作ID。例如,GetById操作的ID设置为"GetById"Create操作的ID设置为"Create",依此类推。

请注意,SwaggerOperationAttribute位于Swashbuckle.AspNetCore.Annotations命名空间中。确保在使用之前将其添加为依赖项。

当你启动应用程序并访问Swagger UI时,它将显示自定义的操作ID。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...