在WinForms（.NET Framework 4.7）中创建REST API服务的技术问询

实现步骤 #

1. 安装必要的NuGet包 #

需要安装OWIN自托管和Web API相关依赖，通过NuGet包管理器控制台执行以下命令：

Install-Package Microsoft.AspNet.WebApi.OwinSelfHost
Install-Package Microsoft.Owin.Host.HttpListener

2. 配置OWIN启动类 #

创建OWIN启动类，用于初始化Web API的路由规则：

using Owin;
using System.Web.Http;

public class Startup
{
    public void Configuration(IAppBuilder appBuilder)
    {
        HttpConfiguration config = new HttpConfiguration();
        // 配置默认API路由
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        appBuilder.UseWebApi(config);
    }
}

3. 创建数据转发API控制器 #

编写控制器处理应用内数据的转发逻辑，将数据发送到目标网站：

using System.Net;
using System.Net.Http;
using System.Web.Http;

public class DataSenderController : ApiController
{
    // POST请求接口，接收应用内数据并转发
    public HttpResponseMessage Post([FromBody] AppData appData)
    {
        using (var httpClient = new HttpClient())
        {
            // 替换为目标网站的实际数据接收地址
            var response = httpClient.PostAsJsonAsync("https://目标网站接收地址", appData).Result;
            
            return response.IsSuccessStatusCode 
                ? Request.CreateResponse(HttpStatusCode.OK, "数据转发成功")
                : Request.CreateErrorResponse(HttpStatusCode.BadGateway, "转发至网站失败");
        }
    }
}

// 定义应用内数据模型，根据实际业务调整字段
public class AppData
{
    public int Id { get; set; }
    public string Content { get; set; }
    // 可添加更多业务字段
}

4. 在WinForms窗体中管理API服务生命周期 #

在主窗体代码中实现API服务的启动、停止，以及应用内调用API的逻辑：

using Microsoft.Owin.Hosting;
using System;
using System.Windows.Forms;

public partial class MainForm : Form
{
    private IDisposable _apiServer;
    // 自定义本地API监听地址，端口可按需修改
    private const string ApiBaseAddress = "http://localhost:9000/";

    public MainForm()
    {
        InitializeComponent();
    }

    private void MainForm_Load(object sender, EventArgs e)
    {
        // 启动内部API服务
        try
        {
            _apiServer = WebApp.Start<Startup>(ApiBaseAddress);
            MessageBox.Show("内部API服务已启动");
        }
        catch (Exception ex)
        {
            MessageBox.Show($"API启动失败：{ex.Message}");
        }
    }

    private void MainForm_FormClosing(object sender, FormClosingEventArgs e)
    {
        // 关闭窗体时停止API服务
        _apiServer?.Dispose();
    }

    // 示例：应用内触发数据发送
    private void btnSendData_Click(object sender, EventArgs e)
    {
        using (var client = new HttpClient())
        {
            var testData = new AppData { Id = 1, Content = "测试数据内容" };
            var response = client.PostAsJsonAsync($"{ApiBaseAddress}api/datasender", testData).Result;
            
            MessageBox.Show(response.IsSuccessStatusCode 
                ? "数据已通过内部API发送" 
                : $"发送失败：{response.ReasonPhrase}");
        }
    }
}

5. 关键注意事项 #

• 确保监听端口未被占用，可根据实际情况修改端口号。
• 若需外部访问该内部API，需将ApiBaseAddress改为http://0.0.0.0:9000/，同时确保防火墙允许该端口的入站连接。
• 实际开发中建议使用await替代.Result处理异步请求，避免阻塞UI线程。

内容的提问来源于stack exchange，提问作者Abd ul rahaman Shalata