lol-esports-api 0.0.17

League of Legends Esports API
Documentation

Rust API for lol-esports-api

League of Legends Esports API

Overview

This client/server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

  • API version: 0.0.17
  • Build date: 2023-02-19T23:00:50.653017-08:00[America/Los_Angeles]

This autogenerated project defines an API crate lol-esports-api which contains:

  • An Api trait defining the API in Rust.
  • Data types representing the underlying data model.
  • A Client type which implements Api and issues HTTP requests for each operation.
  • A router which accepts HTTP requests and invokes the appropriate Api method for each operation.

It also contains an example server and client which make use of lol-esports-api:

  • The example server starts up a web server using the lol-esports-api router, and supplies a trivial implementation of Api which returns failure for every operation.
  • The example client provides a CLI which lets you invoke any single operation on the lol-esports-api client by passing appropriate arguments on the command line.

You can use the example server and client as a basis for your own code. See below for more detail on implementing a server.

Examples

Run examples with:

cargo run --example <example-name>

To pass in arguments to the examples, put them after --, for example:

cargo run --example client -- --help

Running the example server

To run the server, follow these simple steps:

cargo run --example server

Running the example client

To run a client, follow one of the following simple steps:

cargo run --example client GetLeagueByCode
cargo run --example client GetLeagues
cargo run --example client GetMatchesForTournament
cargo run --example client GetMostRecentTournament
cargo run --example client GetOngoingTournanments
cargo run --example client GetPlayersOnTeam
cargo run --example client GetTeamByCode
cargo run --example client GetTeams
cargo run --example client GetTournament
cargo run --example client GetTournamentsForLeague

HTTPS

The examples can be run in HTTPS mode by passing in the flag --https, for example:

cargo run --example server -- --https

This will use the keys/certificates from the examples directory. Note that the server chain is signed with CN=localhost.

Using the generated library

The generated library has a few optional features that can be activated through Cargo.

  • server
    • This defaults to enabled and creates the basic skeleton of a server implementation based on hyper
    • To create the server stack you'll need to provide an implementation of the API trait to provide the server function.
  • client
    • This defaults to enabled and creates the basic skeleton of a client implementation based on hyper
    • The constructed client implements the API trait by making remote API call.
  • conversions
    • This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.

See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section for how to use features in your Cargo.toml.

Documentation for API Endpoints

All URIs are relative to https://v2-api.lol-esports.mckernant1.com

Method HTTP request Description
getLeagueByCode GET /leagues/{leagueId}
getLeagues GET /leagues
getMatchesForTournament GET /matches/{tournamentId}
getMostRecentTournament GET /most-recent-tournament/{leagueId}
getOngoingTournanments GET /ongoing-tournaments
getPlayersOnTeam GET /players/{teamId}
getTeamByCode GET /teams/{teamId}
getTeams GET /teams
getTournament GET /tournament/{tournamentId}
getTournamentsForLeague GET /tournaments/{leagueId}

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author