redmine-net-api
A modern and flexible .NET client library to interact with Redmine's REST API.
π Features
- Full REST API support with CRUD operations
- Supports both XML and JSON data formats
- Handles GZipped server responses transparently
- Easy integration via NuGet package
- Actively maintained and community-driven
| Resource | Read | Create | Update | Delete |
|---|---|---|---|---|
| Attachments | β | β | β | β |
| Custom Fields | β | β | β | β |
| Enumerations | β | β | β | β |
| Files | β | β | β | β |
| Groups | β | β | β | β |
| Issues | β | β | β | β |
| Issue Categories | β | β | β | β |
| Issue Relations | β | β | β | β |
| Issue Statuses | β | β | β | β |
| My Account | β | β | β | β |
| News | β | β | β | β |
| Projects | β | β | β | β |
| Project Memberships | β | β | β | β |
| Queries | β | β | β | β |
| Roles | β | β | β | β |
| Search | β | |||
| Time Entries | β | β | β | β |
| Trackers | β | β | β | β |
| Users | β | β | β | β |
| Versions | β | β | β | β |
| Wiki Pages | β | β | β | β |
π¦ Installation
Add the package via NuGet:
dotnet add package Redmine.Net.Api
Or via Package Manager Console:
Install-Package Redmine.Net.Api
π§βπ» Usage Example
using Redmine.Net.Api;
using Redmine.Net.Api.Types;
using System;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
var options = new RedmineManagerOptionsBuilder()
.WithHost("https://your-redmine-url")
.WithApiKeyAuthentication("your-api-key");
var manager = new RedmineManager(options);
// Retrieve an issue asynchronously
var issue = await manager.GetAsync<Issue>(12345);
Console.WriteLine($"Issue subject: {issue.Subject}");
}
}
Explore more usage examples on the Wiki.
π Documentation
Detailed API reference, guides, and tutorials are available in the GitHub Wiki.
π Contributing
See the CONTRIBUTING.md for detailed guidelines.
π¬ Join on Slack
Want to talk about Redmine integration, features, or contribute ideas?
Join Slack channel here: dotnet-redmine
π€ Contributors
Thanks to all contributors!
π License
This project is licensed under the Apache License 2.0.
β Support
If you find this project useful, consider to support development.