@themaxdavitt/riot-games-apis

Auto-generated axios-powered Typescript Riot Games API client

Usage no npm install needed!

<script type="module">
  import themaxdavittRiotGamesApis from 'https://cdn.skypack.dev/@themaxdavitt/riot-games-apis';
</script>

README

@themaxdavitt/riot-games-apis

NPM link Package license

Auto-generated axios-powered Typescript Riot Games API client.

Building

We use MingweiSamuel/riotapi-schema to generate an OpenAPI 3.0 definition, and then feed it into openapi-client-axios and openapi-client-axios-typegen. That's it.

We do this automatically in npm run build before publishing. Just sit back and relax.

Documentation

After building, HTML documentation is generated in a docs/ folder. You can access it at node_modules/@themaxdavitt/riot-games-apis/docs/index.html or online.

Versioning

We're following a SemVer-compatible version of CalVer (equivalent to date +0.%Y.%-j) since we have no idea when Riot will update their APIs.

License

@themaxdavitt/riot-games-apis is released under the MIT license.