vs2019创建webapi
1.创建新的项目
2.选择.NET CORE的ASP .NET CORE WEB应用程序
3.定义项目名称和存放地点
4.选择API创建项目
5.删除原本的无用的类
6.添加新的方法类
7.设置路由
using Microsoft.AspNetCore.Components;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace WEBAPI.Controllers
{
/// <summa
在本文中，我们将详细探讨如何使用Visual Studio 2019 (VS2019) 和 .NET Core 创建一个Web API，特别针对“WeiApi”的创建过程。我们需要了解Web API是用于构建HTTP服务的应用程序，这些服务可以提供数据以供其他应用程序使用，如网页、移动应用或其他API。
步骤1：创建新项目
启动VS2019，选择“新建项目”，然后在项目模板中找到并选择“.NET Core”下的“ASP.NET Core Web 应用程序”。
步骤2：选择项目类型
在接下来的对话框中，选择“API”作为项目模板，这将创建一个预配置为Web API项目的模板。
步骤3：定义项目设置
输入项目名称（例如“WeiApi”）和存储位置，然后点击“创建”。
步骤4：删除默认类
项目创建后，你可以看到默认生成的一些文件和类。由于我们的目标是创建自定义的API，所以可以删除不需要的默认控制器，例如“ValuesController”。
步骤5：添加新控制器
接下来，右键单击“Controllers”文件夹，选择“添加”->“控制器”。创建一个新的API控制器，命名为“CalculationController”。
步骤6：设置路由
在新创建的`CalculationController`中，我们使用装饰器来定义路由模式。如下所示：
```csharp
[Route("api/[controller]/[action]")]
public class CalculationController : ControllerBase
```
这段代码告诉API，所有该控制器中的方法将遵循`api/Calculation/{action}`的路由模式。
步骤7：编写接口方法
在`CalculationController`中，我们可以定义不同的HTTP操作方法，如GET和POST。这里我们创建了三个方法：获取文本的GET方法、两数相加的GET方法以及两数相减的POST方法。示例代码如下：
```csharp
[HttpGet]
public ActionResult<string> Get()
{
return "Hello World!";
}
[HttpGet]
public ActionResult<int> Sum(int num1, int num2)
{
return num1 + num2;
}
[HttpPost]
public ActionResult<int> Subtract(Param param)
{
int result = param.num1 - param.num2;
return result;
}
```
`Param`类用于承载POST请求的参数：
```csharp
public class Param
{
public int num1 { get; set; }
public int num2 { get; set; }
}
```
步骤8：调试与测试
在VS2019中，可以使用内置的调试工具运行API。设置断点，然后通过浏览器或Postman等工具调用API进行测试。例如，访问`http://localhost:port/api/Calculation/get` 来测试“Get”方法。
步骤9：集成Swagger
为了便于API的管理和调试，我们可以引入Swagger。通过NuGet包管理器安装`Swashbuckle.AspNetCore`。接着，在`Startup.cs`的`ConfigureServices`方法中添加Swagger配置：
```csharp
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "接口文档",
Description = "RESTful API"
});
// 添加XML注释路径
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
```
在`Configure`方法中启用SwaggerUI：
```csharp
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "接口文档 v1");
});
```
现在，当应用运行时，可以通过`http://localhost:port/swagger` 访问Swagger UI，它提供了一个用户友好的界面来测试和浏览API。
总结：
通过以上步骤，我们已经成功地使用VS2019和.NET Core创建了一个简单的Web API，包括定义路由、实现HTTP操作方法以及集成Swagger进行API管理。这只是一个基础的起点，实际开发中，你可能需要处理更复杂的业务逻辑、身份验证、错误处理、数据库交互等多个方面，但这个过程为后续的开发工作打下了坚实的基础。
评论5