An open API service indexing awesome lists of open source software.

https://github.com/zapadi/redmine-net-api

.Net API for Redmine bug/task management systems.
https://github.com/zapadi/redmine-net-api

api-client c-sharp dotnet dotnet-framework dotnetcore redmine redmine-api rest-api-client

Last synced: 4 days ago
JSON representation

.Net API for Redmine bug/task management systems.

Awesome Lists containing this project

README

          

# ![Redmine .NET API](https://raw.githubusercontent.com/zapadi/redmine-net-api/master/logo.png) redmine-net-api

[![NuGet](https://img.shields.io/nuget/v/redmine-api.svg)](https://www.nuget.org/packages/redmine-api)
[![NuGet Downloads](https://img.shields.io/nuget/dt/redmine-api)](https://www.nuget.org/packages/redmine-api)
[![License](https://img.shields.io/github/license/zapadi/redmine-net-api)](LICENSE)
[![Contributors](https://img.shields.io/github/contributors/zapadi/redmine-net-api)](https://github.com/zapadi/redmine-net-api/graphs/contributors)

A modern and flexible .NET client library to interact with [Redmine](https://www.redmine.org)'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:

```bash
dotnet add package Redmine.Net.Api
```

Or via Package Manager Console:

```powershell
Install-Package Redmine.Net.Api
```

## 🧑‍💻 Usage Example

```csharp
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(12345);
Console.WriteLine($"Issue subject: {issue.Subject}");
}
}
```
Explore more usage examples on the [Wiki](https://github.com/zapadi/redmine-net-api/wiki).

## 📚 Documentation

Detailed API reference, guides, and tutorials are available in the [GitHub Wiki](https://github.com/zapadi/redmine-net-api/wiki).

## 🙌 Contributing

See the [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.

## 💬 Join on Slack

Want to talk about Redmine integration, features, or contribute ideas?
Join Slack channel here: [dotnet-redmine](https://join.slack.com/t/dotnet-redmine/shared_invite/zt-36cvwm98j-10Sw3w4LITk1N6eqKKHWRw)

## 🤝 Contributors

Thanks to all contributors!



## 📝 License

This project is licensed under the [Apache License 2.0](LICENSE).

## ☕ Support

If you find this project useful, consider ![[buying me a coffee](https://cdn.buymeacoffee.com/buttons/lato-yellow.png)](https://www.buymeacoffee.com/vXCNnz9) to support development.