搜索结果

×

搜索结果将在这里显示。

🚀快速开始

MicroServer 官方文档

—— 轻量嵌入·跨平台部署·高性能 .NET WebAPI 框架

什么是 MicroServer?

MicroServer 是一款专为 .NET 生态设计的可内嵌式轻量级高性能 WebAPI 框架,基于 .NET Standard 2.0 构建,无需依赖 IIS、Kestrel 等外部服务器,可直接嵌入各类 .NET 应用中,快速搭建轻量级 WebAPI 服务。

它以「开箱即用、无侵入业务、集成简单」为核心设计理念,完美支持跨平台部署(Windows/macOS/Linux)与 AOT 编译,让开发者无需关注复杂的服务器配置,专注于业务逻辑实现,大幅降低轻量级 API 服务的开发与部署成本。

核心特性

🌐 跨平台兼容,部署灵活

基于 .NET Standard 2.0 构建,兼容 .NET Framework、.NET Core、.NET 5+ 等全系列 .NET 框架,可部署于 Windows、macOS、Linux 等各类操作系统,支持容器化部署与边缘设备场景。

🚀 轻量高性能,无依赖负担

核心库无额外第三方依赖,打包体积小,启动速度快(毫秒级初始化);支持异步请求处理,并发性能优异,轻松应对轻量级 API 服务的高并发场景。

🛠️ 极简集成,开箱即用

无需复杂配置,仅需 3 行核心代码即可启动 WebAPI 服务;支持灵活路由映射,支持 GET/POST 等各类 HTTP 请求方法,满足绝大多数 API 开发需求。

✨ 无侵入设计,兼容现有业务

可无缝集成至已有 .NET 项目,不侵入原有业务逻辑,无需重构代码即可快速扩展 API 能力,适配 legacy 项目升级与新项目快速开发场景。

📦 支持 AOT 编译,性能再升级

完美兼容 .NET 原生 AOT 编译,编译后无需依赖 .NET 运行时即可独立运行,启动速度、内存占用、响应性能均得到进一步优化,适配资源受限场景。

快速体验

只需 5 分钟,即可搭建你的第一个 MicroServer WebAPI 服务:

1. 安装依赖

通过 NuGet 包管理器安装 MicroServer:

# .NET CLI
dotnet add package MicroServer --version 1.2.0

# PMC
NuGet\Install-Package MicroServer -Version 1.2.0

2. VB.NET示例

Imports System.Net
Imports MicroServer

Module FastTest
    Private ReadOnly MyAPI As New WebAPIServer
    Sub Main()
        MyAPI.AddRoute("/", AddressOf hello) '添加路由映射
        MyAPI.StartServer() '启动 WebAPI 服务,默认端口8090 传入参数可修改端口
        Console.WriteLine("访问地址:http://127.0.0.1:8090")
        Console.ReadKey()
    End Sub

    Private Async Function hello(request As HttpListenerRequest, response As HttpListenerResponse) As Task
        Await response.WriteAsync(<t>{"code":1,"msg":"Hello WebAPI"}</t>.Value)
    End Function
End Module

3. C#示例

using System.Net;
using MicroServer;

namespace FastTestNamespace
{
    public static class FastTest
    {
        private static readonly WebAPIServer MyAPI = new WebAPIServer();

        public static void Main()
        {
            MyAPI.AddRoute("/", Hello); // 映射根路由
            MyAPI.StartServer(); // 启动服务(默认端口 8090)
            Console.WriteLine("MicroServer 启动成功!访问地址:http://127.0.0.1:8090");
            Console.ReadKey();
        }

        // 异步请求处理方法
        private static async Task Hello(HttpListenerRequest request, HttpListenerResponse response)
        {
            await response.WriteAsync("""{"code":1,"msg":"Hello WebAPI"}""");
        }
    }
}

4. 运行测试

启动项目后,访问 http://127.0.0.1:8090,即可收到响应结果:

{"code":1,"msg":"Hello WebAPI"}

适用场景

  • 🔧 工具类软件的 API 接口扩展(如桌面应用对外提供数据接口)
  • 📡 边缘设备/物联网(IoT)场景的轻量级 API 服务
  • 🚀 微服务架构中的轻量级通信节点
  • 📦 legacy 项目的 API 化改造(无需重构原有架构)
  • 🧪 快速原型开发(快速搭建临时 API 服务验证业务逻辑)
  • 🎯 Windows 服务/控制台应用的 HTTP 接口需求

文档导航

  • 快速开始:安装配置、第一个 API 服务、路由基础
  • API 参考:核心类、方法详解、请求/响应处理
  • 示例代码:控制台应用、Windows 服务、跨平台部署等场景示例
  • 配置指南:端口配置、跨域设置、日志集成
  • 常见问题:安装失败、启动异常、性能优化、兼容问题排查

版本信息

当前稳定版本:v1.2.0
兼容框架:.NET Standard 2.0 及以上(.NET Framework 4.6.1+、.NET Core 2.0+、.NET 5+)

开始探索

点击「快速开始」,立即搭建你的第一个 MicroServer 服务,体验轻量级 API 开发的高效与便捷!