Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 3.1 KB

Utilities.md

File metadata and controls

76 lines (60 loc) · 3.1 KB

Utilities

There are various important utility classes.

OLLoader

For each of OpenLibrary's APIs there is a static Loader class. These supply a simple interface for requesting and parsing specific data from OpenLibrary.

OLAuthorData authorData = await OLAuthorLoader.GetDataAsync("OL28104A");
OLWorkData workData = await OLWorkLoader.GetDataAsync("OL21019691W");
OLRatingsData workRatings = await OLWorkLoader.GetRatingsAsync("OL21019691W");

For examples for each Loader class, see the respective API's documentations.

OpenLibraryUtility

The main utility class. Provides various helpful methods and variables.

Constants

Provides the base URLs for the various APIs.

public const string BaseURL = "https://openlibrary.org/";
public const string BaseURL_Covers = "https://covers.openlibrary.org/";

Maps

PathParametersMaps

For each API, there is a readonly dictionary defined that maps the APIs' requests paths to the parameters that are valid for this path.

For example:

public static readonly ReadOnlyDictionary<string, List<string>> WorksPathParametersMap = new ReadOnlyDictionary<string, List<string>>
(
    new Dictionary<string, List<string>>
    {
        {string.Empty, new List<string>() },
        {"editions", new List<string>(){ "limit", "offset" } },
        {"bookshelves", new List<string>() },
        {"ratings", new List<string>() },
    }
);

Note that these are not guaranteed to be complete. To maintain flexibility in case of API changes, these are not enforced anywhere within the other classes.

RequestTypePrefixMap

The RequestTypePrefixMap

public static readonly ReadOnlyDictionary<OLRequestAPI, string> RequestTypePrefixMap = ...

maps the various APIs to their url prefix (i.e., OLRequestAPI.Authors => "authors", OLRequestAPI.Covers => "b" etc.)

BuildURL

Simple helper method to correctly format an OpenLibrary url.

public static string BuildURL(OLRequestAPI api, string? id = null, string? path = null, params KeyValuePair<string, string>[] parameters);

// Examples
OpenLibraryUtility.BuildURL(OLRequestAPI.Authors, "OL274606A", "works", new KeyValuePair<string, string>("limit", "10"));

Requests

Provides basic methods for making web requests. Uses private static HttpClient.

Also provides method to request and then parse data.

public async static Task<string> RequestAsync(string url);
public async static Task<T> LoadAsAsync<T>(string url, string path = "");

// Examples
string response = OpenLibraryUtility.RequestAsync("https://openlibrary.org/authors/OL274606A.json");
OLWorkData[] workData = OpenLibraryUtility.LoadAs<OlWorkData>("https://openlibrary.org/authors/OL274606A/works.json", "entries");
// Note: The work collection is the "entries" variable in the json response of the given url.
// The path parameter in LoadAsAsync is the path within the json structure.