怎么使用C#通过VisualStudio2017搭建网页API接口

发布时间：2021-11-24 09:06:28 作者：iii
来源：亿速云阅读：2180

# 怎么使用C#通过VisualStudio2017搭建网页API接口

## 前言
在当今Web开发领域，ASP.NET Web API是构建RESTful服务的核心框架之一。本文将详细介绍如何通过Visual Studio 2017使用C#语言快速搭建一个功能完整的网页API接口，涵盖从环境配置到部署测试的全过程。

---

## 一、环境准备
### 1. 安装必要软件
- **Visual Studio 2017**（社区版/专业版）
  - 安装时勾选"ASP.NET和Web开发"工作负载
- **.NET Framework 4.6+**（VS2017默认包含）
- **Postman**（用于API测试）

### 2. 验证安装
```bash
# 打开PowerShell验证.NET版本
dotnet --version

二、创建Web API项目

启动VS2017 → 新建项目 → ASP.NET Web应用程序(.NET Framework)
选择模板：
- 项目类型：Web API
- 身份验证：暂时选择”无身份验证”

解决方案结构说明：


/Controllers       # API控制器
/Models           # 数据模型
/App_Start        # 配置类
Global.asax       # 全局应用类

三、核心代码实现

1. 创建数据模型

// Models/Product.cs
public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

2. 实现API控制器

// Controllers/ProductsController.cs
public class ProductsController : ApiController
{
    private static List<Product> products = new List<Product>()
    {
        new Product { Id = 1, Name = "Laptop", Price = 999.99m },
        new Product { Id = 2, Name = "Mouse", Price = 19.99m }
    };

    // GET api/products
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    // GET api/products/1
    public IHttpActionResult GetProduct(int id)
    {
        var product = products.FirstOrDefault(p => p.Id == id);
        if (product == null) return NotFound();
        return Ok(product);
    }
}

3. 路由配置

// App_Start/WebApiConfig.cs
public static void Register(HttpConfiguration config)
{
    // 启用属性路由
    config.MapHttpAttributeRoutes();

    // 默认路由
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
}

四、关键功能扩展

1. 添加POST方法

[HttpPost]
public IHttpActionResult CreateProduct(Product product)
{
    if (!ModelState.IsValid)
        return BadRequest(ModelState);
    
    product.Id = products.Max(p => p.Id) + 1;
    products.Add(product);
    return CreatedAtRoute("DefaultApi", new { id = product.Id }, product);
}

2. 实现数据持久化（使用Entity Framework）

通过NuGet安装：
```
Install-Package EntityFramework
```

创建DbContext：


public class ProductContext : DbContext
{
   public DbSet<Product> Products { get; set; }
}

五、调试与测试

1. 启动项目

按F5启动调试，浏览器将自动打开：

https://localhost:44300/api/products

2. 使用Postman测试

方法	URL	请求体示例
GET	/api/products	-
GET	/api/products/1	-
POST	/api/products	{ “Name”:“Keyboard”, “Price”:49.99 }

六、部署到IIS

发布项目：
- 右键项目 → 发布 → 选择”文件夹”
IIS配置：
- 添加网站 → 指定物理路径
- 应用程序池使用.NET 4.0集成模式

常见问题解决

404错误：
- 检查路由配置
- 确认控制器以”Controller”结尾
500内部错误：
- 查看Windows事件日志
- 启用详细错误信息：
```
<system.web>
 <customErrors mode="Off"/>
</system.web>
```

结语

通过本文的步骤，您已经成功创建了一个基础的Web API服务。建议进一步学习： - JWT身份验证 - Swagger文档集成 - 异步控制器实现

完整示例代码可访问：GitHub仓库链接 “`

注：实际使用时请将占位符（如GitHub链接）替换为真实内容，文章长度可根据需要增减具体实现细节。