A .Net wrapper for the Pokemon API at https://pokeapi.co.
Targets .Net Standard 2.0.
using PokeApiNet.Data; using PokeApiNet.Models; ... // instantiate client PokeApiClient pokeClient = new PokeApiClient(); // get a resource by name Pokemon hoOh = await pokeClient.GetResourceAsync<Pokemon>("ho-oh"); // ... or by id Item clawFossil = await pokeClient.GetResourceAsync<Item>(100);
To see all the resources that are available, see the PokeAPI docs site.
PokeAPI uses navigation urls for many of the resource's properties to keep requests lightweight, but require subsequent requests in order to resolve this data. Example:
Pokemon pikachu = await pokeClient.GetResourceAsync<Pokemon>("pikachu");
pikachu.Species only has a
Url property. In order to load this data, an additonal request is needed; this is more of a problem when the property is a list of navigation URLs, such as the
GetResourceAsync includes overloads to assist with resolving these navigation properties. Example:
// to resolve a single navigation url property PokemonSpecies species = await pokeClient.GetResourceAsync(pikachu.Species); // to resolve a list of them List<Move> allMoves = await pokeClient.GetResourceAsync(pikachu.Moves.Select(move => move.Move));
PokeAPI supports the paging of resources, allowing users to get a list of available resources for that API. Depending on the shape of the resource data, two methods for paging are included, along with overloads to allow for the specification of the page count limit and the page offset. Example:
// get a page of data (defaults to a limit of 20) NamedApiResourceList<Berry> firstBerryPage = await client.GetNamedResourcePageAsync<Berry>(); // to specify a certain page, use the provided overloads NamedApiResourceList<Berry> lotsMoreBerriesPage = await client.GetNamedResourcePageAsync<Berry>(60, 2);
Berry resource has a
Name property, the
GetNamedResourcePageAsync() method is used. For resources that do not have a
Name property, use the
GetApiResourcePageAsync() method. Example:
ApiResourceList<ContestEffect> contestEffectPage = await client.GetApiResourcePageAsync<ContestEffect>();
Regardless of which method is used, the returning object includes a
Results collection that can be used to pull the full resource data. Example:
Berry cheri = await client.GetResourceAsync<Berry>(firstBerryPage.Results);
Refer to the PokeAPI documention to see which resources include a
Every resource response is automatically cached in memory, making all subsequent requests for the same resource pull cached data. Example:
// this will fetch the data from the API Pokemon mew = await pokeClient.GetResourceAsync<Pokemon>(151); // another call to the same resource will fetch from the cache Pokemon mewCached = await pokeClient.GetResourceAsync<Pokemon>("mew");
To clear the cache of data:
// clear all caches pokeClient.ClearCache(); // clear a particular resource type's cache pokeClient.ClearCache<Item>();
The test bank includes unit tests and integration tests. Integration tests will actually ping the PokeApi server for data while the unit tests run off of mocked data.
dotnet test --filter "Category = Unit" dotnet test --filter "Category = Integration"