https://github.com/xc0dex/apiweaver

A powerful library for customizing OpenAPI documents generated by Microsoft's OpenAPI generator in .NET 9
https://github.com/xc0dex/apiweaver

aspnetcore dotnet openapi swagger

Last synced: 13 days ago
JSON representation

A powerful library for customizing OpenAPI documents generated by Microsoft's OpenAPI generator in .NET 9

• Host: GitHub
• URL: https://github.com/xc0dex/apiweaver
• Owner: xC0dex
• License: mit
• Created: 2024-01-21T17:12:38.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T17:42:33.000Z (25 days ago)
• Last Synced: 2024-10-23T19:50:48.085Z (23 days ago)
• Topics: aspnetcore, dotnet, openapi, swagger
• Language: C#
• Homepage:
• Size: 424 KB
• Stars: 15
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# APIWeaver

[![Pipeline](https://github.com/xC0dex/APIWeaver/actions/workflows/ci.yml/badge.svg)](https://github.com/xC0dex/APIWeaver/actions/workflows/ci.yml)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=xC0dex_APIWeaver&metric=coverage)](https://sonarcloud.io/summary/new_code?id=xC0dex_APIWeaver)

[![NuGet Version](https://img.shields.io/nuget/v/APIWeaver.OpenApi)](https://www.nuget.org/packages/APIWeaver.OpenApi/)

[![NuGet Downloads](https://img.shields.io/nuget/dt/APIWeaver.OpenApi)](https://www.nuget.org/packages/APIWeaver.OpenApi/)

`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](docs/Getting-Started.md) 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](LICENSE) for more information.

This means APIWeaver will always remain free.