Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.38 KB

File metadata and controls

38 lines (29 loc) · 1.38 KB

FauxSharp

FauxSharp is a simple C# SDK for communicating with FauxApi on PFSense

Build

Build Status

Installation

Use Nuget to install FauxApi Sdk.

Install-Package FauxApi

Usage

FauxSharp can be easily used with dependency injection in Asp.net core. Just setup the services like so:

services.AddSingleton<IApiBaseService>(x => new ApiBaseService(new ClientBaseOptions("https://pfsense_fauxapi_host","apikey","apisecret",false,true)));
services.AddSingleton<IApiService, ApiService>();

The ApiBaseService can also be created without the CLientBaseOptions and you can configure it later, see further down. You can then inject the service in your own services etc. and call it:

await ApiService.SystemStats();

If you want to change / set the ClientBaseOptions outside of the service setup, just do this:

await ApiBaseService.UpdateConfiguration(new ClientBaseOptions("https://pfsense_fauxapi_host2","apikey2","apisecret2",false,true));

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT