Skip to main content

Kanji Alive NuGet Package

· 2 min read
Scottie Enriquez
Scottie Enriquez
Solutions Architect at Amazon Web Services

Overview​

This NuGet package provides a C# interface to easily query and fetch kanji data from the Kanji Alive public API. This package is designed to simplify development of Japanese learning desktop and web applications on the C#/.NET platform.

Usage​

All of the API endpoints are accessible using the KanjiAliveClient. To use the client, simply instantiate while passing your Mashape API key as the sole constructor parameter. You can obtain an API key here.

KanjiAliveClient client = new KanjiAliveClient("MY_API_KEY");

Nested inside of the main client are three subclients that mirror the structure of the API endpoints: AdvancedSearchClient, BasicSearchClient, and KanjiDetailsClient. The endpoints are exposed as asynchronous instance methods, so be sure to await them.

<List<KanjiSimpleResponse>> apiResponse = await client.AdvancedSearchClient.SearchByKanjiStrokeNumber(5);

Contributing​

In order to obfuscate your API key for integration tests, add your API key to the Windows Registry as a string value with the key set to MASHAPE_API_KEY. This allows you to discreetly fetch your key at runtime instead of exposing it in the source code.

KanjiAliveClient client = new KanjiAliveClient(Environment.GetEnvironmentVariable("MASHAPE_API_KEY"));

Please ensure that any code additions follow the styling laid out in the .DotSettings file and that all unit and integration tests pass before submitting a pull request. For break fixes, please add tests. For any questions, issues, or enhancements, please use the issue tracker for this repository.

Build Status​

Build status

Thanks​

Special thanks to the Kanji Alive team for not only providing their kanji data in a clean, consumable format, but also for hosting a RESTful API to expose it too. Note that if you would like to include this kanji data locally in your project, you can download the language data and media directly from this repo.