https://github.com/remora/remora.rest
Reusable tooling for interacting with JSON-driven REST APIs
https://github.com/remora/remora.rest
Last synced: 12 months ago
JSON representation
Reusable tooling for interacting with JSON-driven REST APIs
- Host: GitHub
- URL: https://github.com/remora/remora.rest
- Owner: Remora
- License: lgpl-3.0
- Created: 2021-09-20T18:40:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T13:08:38.000Z (over 1 year ago)
- Last Synced: 2025-04-09T16:09:39.810Z (about 1 year ago)
- Language: C#
- Size: 657 KB
- Stars: 7
- Watchers: 1
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Remora.Rest
===========
Remora.Rest is a compact helper library for building REST API wrappers, giving
you the tools you need to rapidly create robust, highly configurable wrappers of
your own.
The library is somewhat opinionated, and it does target a single subset of REST
API types - those whose payloads (error or otherwise) are JSON-serialized. For
these use cases, however, the library is quite adept at what it does.
## Quickstart
At its core, the library expects you to do two things - one, to access the REST
endpoints through a configured `RestHttpClient`, and two, to define the
entities in the API model through an interface/implementation combination.
```c#
var services = new ServiceCollection();
var clientBuilder = services
.AddRestHttpClient>();
// Perform HttpClient configuration (adding Polly policies, setting default
// request headers, etc)
clientBuilder...
// Configure API model types
services.Configure(clientBuilder.Name, options =>
{
options.AddDataObjectConverter();
});
```
After you've set up your client and your types, you can then inject an instance
of `RestHttpClient` into your actual API wrapper type (the instance is
transient, so you can treat it the same as any HttpClient you'd normally
inject).
```c#
public class MyWrapper
{
private readonly RestHttpClient _restClient;
public MyWrapper(RestHttpClient restClient)
{
_restClient = restClient;
}
}
```
More detailed documentation will hopefully be available in the future; in the
meantime, check out [Remora.Discord][1], for which this project was originally
developed - it pushes all available functionality to its limits, and serves as a
relatively comprehensive demonstration of what you can do with the library.
[1]: https://github.com/Remora/Remora.Discord