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。

相关内容

热门资讯

安装apache-beam==... 出现此错误可能是因为用户的Python版本太低,而apache-beam==2.34.0需要更高的P...
避免在粘贴双引号时向VS 20... 在粘贴双引号时向VS 2022添加反斜杠的问题通常是由于编辑器的自动转义功能引起的。为了避免这个问题...
Android Recycle... 要在Android RecyclerView中实现滑动卡片效果,可以按照以下步骤进行操作:首先,在项...
omi系统和安卓系统哪个好,揭... OMI系统和安卓系统哪个好?这个问题就像是在问“苹果和橘子哪个更甜”,每个人都有自己的答案。今天,我...
原生ios和安卓系统,原生对比... 亲爱的读者们,你是否曾好奇过,为什么你的iPhone和安卓手机在操作体验上有着天壤之别?今天,就让我...
Android - 无法确定任... 这个错误通常发生在Android项目中,表示编译Debug版本的Java代码时出现了依赖关系问题。下...
Android - NDK 预... 在Android NDK的构建过程中,LOCAL_SRC_FILES只能包含一个项目。如果需要在ND...
Akka生成Actor问题 在Akka框架中,可以使用ActorSystem对象生成Actor。但是,当我们在Actor类中尝试...
Agora-RTC-React... 出现这个错误原因是因为在 React 组件中使用,import AgoraRTC from “ago...
Alertmanager在pr... 首先,在Prometheus配置文件中,确保Alertmanager URL已正确配置。例如:ale...