以下是一个使用ASP.NET Web API(基于 .NET Framework)的简单示例。
1. 创建ASP.NET Web API项目
首先,确保你已经安装了Visual Studio,并且选择了包含ASP.NET和Web开发工作负载的安装选项。
- 打开Visual Studio。
- 选择“创建新项目”。
- 在搜索栏中输入“ASP.NET Web 应用程序(.NET Framework)”,然后选择它并点击“下一步”。
- 为你的项目命名,例如“MyWebApiDemo”,并选择保存位置。
- 在“目标框架”下拉菜单中选择一个.NET Framework版本(例如.NET Framework 4.7.2或更高版本)。
- 点击“创建”。
- 在“新建ASP.NET Web 应用程序”对话框中,选择“Web API”模板,然后点击“确定”。
2. 添加模型类
在解决方案资源管理器中,右键点击“Models”文件夹(如果没有,请创建一个),然后选择“添加” > “类”。将类命名为TodoItem.cs,并添加以下代码:
namespace MyWebApiDemo.Models
{
public class TodoItem
{
public int Id { get; set; }
public string Name { get; set; }
public bool IsComplete { get; set; }
}
}
3. 创建控制器
在解决方案资源管理器中,右键点击“Controllers”文件夹,然后选择“添加” > “控制器”。选择“Web API 2 控制器 - 空”,然后点击“添加”。
将控制器命名为TodoController.cs,并添加以下代码:
using MyWebApiDemo.Models;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
namespace MyWebApiDemo.Controllers
{
public class TodoController : ApiController
{
private static List<TodoItem> todoItems = new List<TodoItem>
{
new TodoItem { Id = 1, Name = "Item1", IsComplete = false },
new TodoItem { Id = 2, Name = "Item2", IsComplete = false }
};
// GET api/todo
public IEnumerable<TodoItem> GetAllTodoItems()
{
return todoItems;
}
// GET api/todo/5
public IHttpActionResult GetTodoItem(int id)
{
var todoItem = todoItems.FirstOrDefault(t => t.Id == id);
if (todoItem == null)
{
return NotFound();
}
return Ok(todoItem);
}
// POST api/todo
public IHttpActionResult PostTodoItem(TodoItem todoItem)
{
todoItem.Id = todoItems.Max(t => t.Id) + 1;
todoItems.Add(todoItem);
return CreatedAtRoute("DefaultApi", new { id = todoItem.Id }, todoItem);
}
// PUT api/todo/5
// DELETE api/todo/5
// To keep the example simple, PUT and DELETE are not implemented.
}
}
4. 配置路由(如果需要)
通常,Web API项目在WebApiConfig.cs文件中配置路由。如果你使用的是ASP.NET Web API默认模板,这个文件应该已经存在,并且配置了默认的路由。你可以检查App_Start文件夹中的WebApiConfig.cs文件,确保它包含类似以下的代码:
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
// Web API 配置和服务
// Web API 路由配置
config.MapHttpAttributeRoutes();
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}
}
5. 运行项目
按F5键或点击“调试” > “开始调试”来运行项目。项目启动后,你可以在浏览器中或使用工具(如Postman)访问以下API端点:
- 获取所有Todo项:GET http://localhost:[端口号]/api/todo
- 获取特定Todo项:GET http://localhost:[端口号]/api/todo/1
- 添加新的Todo项:POST http://localhost:[端口号]/api/todo,请求体为JSON格式,例如:
{
"Name": "New Todo Item",
"IsComplete": false
}
确保将[端口号]替换为Visual Studio在运行时分配给项目的实际端口号。
这样,你就创建了一个基于.NET Framework的ASP.NET Web API项目,并实现了基本的CRUD操作(尽管只实现了GET和POST)。
标签:API,Web,todoItem,WebApiDemo,api,NET,public From: https://www.cnblogs.com/onlylingfeng/p/18639982