Swagger/OpenAPI tooling for ASP.NET Core to automatically generate API documentation and interactive UIs.
Swashbuckle.AspNetCore is a .NET library that automatically generates OpenAPI (Swagger) documentation for ASP.NET Core web APIs. It creates machine-readable API specifications and provides embedded interactive UIs (swagger-ui and ReDoc) that allow developers and consumers to explore, test, and understand API endpoints without manual documentation. It solves the problem of maintaining API documentation that stays synchronized with code changes.
ASP.NET Core developers building RESTful web APIs who need automated, interactive documentation for their endpoints. It's particularly valuable for teams providing APIs to external consumers or internal microservices.
Developers choose Swashbuckle.AspNetCore because it provides comprehensive OpenAPI tooling specifically tailored for ASP.NET Core with minimal configuration. Its tight integration with the ASP.NET Core ecosystem, support for both System.Text.Json and Newtonsoft.Json, and extensible architecture make it the de facto standard for OpenAPI documentation in .NET web APIs.
Swagger tools for documenting API's built on ASP.NET Core
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates OpenAPI 2.0, 3.0, and 3.1 JSON documents directly from ASP.NET Core controllers and minimal APIs with minimal setup, as shown in the Getting Started code snippets.
Includes embedded swagger-ui and ReDoc for live API exploration and testing, providing immediate value without external tools, as highlighted in the README.
Offers extensive customization through operation filters, schema overrides, and UI theming, documented in a detailed Configuration and Customization table.
Supports both System.Text.Json and Newtonsoft.Json via separate packages, ensuring accurate schema generation for different serialization strategies, as explained in the README.
Only works with attribute routing; controllers using conventional routing are not discovered by ApiExplorer, limiting documentation coverage as admitted in the README's Swashbuckle, ApiExplorer, and Routing section.
Version 10 introduces breaking changes due to dependency upgrades, requiring migration efforts as highlighted in the IMPORTANT note, which can disrupt existing projects.
Requires installing a separate Swashbuckle.AspNetCore.Newtonsoft package and explicit configuration, adding complexity and maintenance overhead for teams not using System.Text.Json.