SuperAPI AI 工具集

create-controller

编程与开发

查看项目

更新于 10-15 23:32

技能介绍

用途:在 ASP.NET Core Web API 项目中,为给定实体脚手架生成一个 API 控制器,适合需要快速创建 REST API 控制器的场景。

主要能力与步骤:创建命名为 {EntityName}Controller 的空控制器;配置依赖注入,注入 Entity Framework 上下文与 ILogger<T>;不使用实体类做模型绑定,而是为每个 CRUD 操作创建 DTO 类;添加带 OpenAPI 相关注解的 CRUD REST API 方法;为每个 action 方法添加 OperationId,例如将 [HttpGet] 改为 [HttpGet(Name = "GetCourses")],并取有意义的名称;为每个 action 应用 [ProducesResponseType] 属性以反映 API 行为。

测试与验证:编辑 coursemanagement.http 用于测试,不要改动已有的 @HostAddress 变量定义,使用该变量,测试载荷参考相关实体类;编写 POST 方法时不要添加实体的主键。运行 dotnet build 验证编译。

Swagger UI:添加包 dotnet add package Swashbuckle.AspNetCore.SwaggerUI,并在 Program.cs 中加入 app.UseSwaggerUI(options => { options.SwaggerEndpoint("/openapi/v1.json", "OpenAPI V1"); }); 然后运行 dotnet run 验证应用能成功启动。

前置条件:使用基于控制器的 API;所有 JSON 数据使用 System.Text.Json;项目使用 Entity Framework Core 9,不要安装额外包,项目已配置好。

限制:资料未提供该技能的收费、价格、平台支持范围或效果保证等信息,暂未提供。