Swashbuckle
Swashbuckle 是一款无缝向 ASP.NET Core WebApi 添加 Swagger 文档的开源项目。它自动扫描控制器和模型,生成符合 OpenAPI/Swagger 规范的 JSON,并提供 Swagger UI 交互式文档页面。Swashbuckle 让 API 开发、测试、调试变得直观,是 .NET Web API 开发的标准工具。

项目简介

Swashbuckle 是一款无缝向 ASP.NET Core WebApi 添加 Swagger 文档的开源项目。它自动扫描控制器和模型,生成符合 OpenAPI/Swagger 规范的 JSON,并提供 Swagger UI 交互式文档页面。Swashbuckle 让 API 开发、测试、调试变得直观,是 .NET Web API 开发的标准工具。

核心功能

自动文档
  • 自动生成Swagger规范
  • XML注释集成
  • 数据注解支持
  • 版本管理
Swagger UI
  • 交互式测试页面
  • 在线调试API
  • 客户端SDK生成
  • 美观文档界面
高度定制
  • 操作过滤器
  • 模型示例
  • 安全定义
  • 分组和排序

使用方法

  1. 通过NuGet安装Swashbuckle.AspNetCore
  2. 在Startup中添加Swagger服务
  3. 启用Swagger中间件
  4. 访问/swagger查看文档

适用场景

  • Web API文档自动生成
  • 前后端协作
  • API调试和测试
  • 公开API门户

项目地址

授权方式:免费 + 开源 (MIT)