OpenWeatherMapAPI.ClientLibrary 2.1.0

OpenWeatherMapAPI

A wrapper library for OpenWeatherMap API built in .NET Core 3.1 Currently, the package supports the following endpoints:

• Current Weather Data:
  • By geographic coordinates
• Air Pollution:
  • By geographic coordinates

And the following API versions were tested:

• v2.5

Installation

Package Manager:

Install-Package OpenWeatherMapAPI.ClientLibrary

.NET CLI:

dotnet add package OpenWeatherMapAPI.ClientLibrary

Setup

When using dependency injection in .NET Core 3.X, you can register type like so, by registering a type in the ConfigureServices() method. Outside of the DI registration, the OpenWeatherMapAPIClientConfiguration.APIKey is required, and the rest of the config is optional and has default values:

Startup.cs:

public void ConfigureServices(IServiceCollection services)
{
	OpenWeatherMapAPIClientConfiguration.APIKey = "MY_API_KEY"
	OpenWeatherMapAPIClientConfiguration.APIURL = "API_URL_TO_USE" // OPTIONAL
	OpenWeatherMapAPIClientConfiguration.APIVersion = "API_VERSION_TO_USE" // OPTIONAL


	services.AddScoped<IOpenWeatherMapAPIClient, OpenWeatherMapAPIClient>();
}

MyClass.cs:

public class MyClass
{
	private readonly IOpenWeatherMapAPIClient _api;

	public MyService(IOpenWeatherMapAPIClient api)
	{
		_api = api;
	}
}

Alternatively, you don't have to inject/instantiate the whole API client and only choose services that you need, by injecting i.e. ICurrentWeatherDataService.

You can control which version of OpenWeatherMap API you're using by providing an optional OpenWeatherMapAPIClientConfiguration.APIVersion parameter to your global Startup config and using OpenWeatherMapAPI.Models.Shared.Constants class (i.e. Constants.Ver2_5), or provide the version yourself. You can do the same with the API URL by providing a OpenWeatherMapAPIClientConfiguration.APIVersion in your config. Similarly, this is optional as the default value is provided automatically.

Usage

The example project that uses the below code can be found under OpenWeatherMapAPI.SystemTests. Feel free to clone and play around!

Quickstart:

OpenWeatherMapAPIClientConfiguration.APIKey = "MY_API_KEY"
var apiClient = new OpenWeatherMapAPIClient();
var currentWeather = apiClient.CurrentWeatherData;

var request = new ByGeographicCoordinatesRequest()
{
	Latitude = 53.7998,
	Longitude = 1.5584
};

var result = await currentWeather.ByGeographicCoordinatesAsync(request);

// {"coord":{"lon":1.5584,"lat":53.7998},"weather":[{"id":804,"main":"Clouds","description":"overcast clouds","icon":"04d"}],"base":"stations","main":{"temp":286.48,"feels_like":286.11,"temp_min":286.48,"temp_max":286.48,"pressure":1015,"humidity":86},"visibility":10000,"wind":{"speed":9.68,"deg":180},"clouds":{"all":100},"dt":1634563421,"sys":{"type":2,"id":2029944,"country":"GB","sunrise":1634538410,"sunset":1634575838},"timezone":0,"id":2650519,"name":"Easington","cod":200}

Testing

Some Integration and System tests are available in the repo, but make sure you update the OpenWeatherMapAPI.TestResources.BaseConstants.APIkey constant.

Development

In order to add a new service to the library, you'll need to:

• Add a new endpoint constant in OpenWeatherMapAPI.Models.Shared.Constants
• Add a new folder under OpenWeatherMapAPI.Models with your new service name. In that folder, add a POCO response class
• For each method you're adding, also add a request class in the above namespace (if not existing yet)
• Add a folder under OpenWeatherMapAPI.Services with the new service you're adding and add a concrete class and an abstract interface. Derive your class from APIGateway class. Don't call the API yourself - use your service to construct the request object you need to pass on and use the ExecuteGetAsync<T> method to do the calling for you
• Add your new interface to the OpenWeatherMapAPIClient and IOpenWeatherMapAPIClient as a property
• Following the existing structure, add any sample requests/responses to OpenWeatherMapAPI.TestResources project, add integration tests in OpenWeatherMapAPI.IntegrationTests project and a logic for system tests in OpenWeatherMapAPI.SystemTests

Deployment

Use tags for versioning. Check the current iteration (tag) and in cmd:

git checkout [test/master]
git pull
git tag v[Major].[Minor].[Patch]-[beta if test branch]
git push origin [version]

Then, push the code to test and merge into master.