Skip to content

A powerful library for customizing OpenAPI documents generated by the built-in generator from Microsoft.AspNetCore.OpenApi in .NET 9

License

Notifications You must be signed in to change notification settings

xC0dex/APIWeaver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

APIWeaver

Pipeline Coverage NuGet Version NuGet Downloads

APIWeaver.OpenApi is a lightweight .NET 9 library that extends the OpenAPI document generated by .NET's built-in OpenAPI document generator. It’s compatible with native AOT and offers extension methods and transformers for flexible customization.

Features

  • Authentication: Add security schemes and responses to your OpenAPI documents
  • Examples: Add pre-configured examples for types and parameters
  • Response Descriptions: Add descriptions to responses
  • Servers: Add and manage custom server URLs in OpenAPI documents
  • Native AOT compatibility: Fully compatible with native AOT
  • Additional Extensions: More extension methods and transformers for customizing OpenAPI documents, operations, and schemes

🚀 Getting Started

Head over to the documentation to dive into how APIWeaver.OpenApi works and explore all its features.

🛠️ Roadmap

  • WIP: More useful transformers for OpenAPI documents, operations and schemes
  • Later: Minimal, native AOT friendly generator for API Clients

💬 Feedback & Suggestions

Your feedback is important to make APIWeaver even better! If you have ideas for new features, improvements, or other thoughts, please feel free to share them.

🤝 Contributing

Contributions are welcome! Feel free to open issues or pull requests.

License

This project is licensed under the MIT License. See LICENSE for more information. This means APIWeaver will always remain free.

About

A powerful library for customizing OpenAPI documents generated by the built-in generator from Microsoft.AspNetCore.OpenApi in .NET 9

Topics

Resources

License

Stars

Watchers

Forks

Languages