AspNetCore自定义/显式Swagger操作ID
创始人
2024-09-20 09:31:48
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。

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...