☕ AGHPB4J 📚

_{Java Wrapper for the anime girls holding programming books API.}

Note

I am not the original author of the AGHPB API. You can view their Wrappers for other Languages here.

This Wrapper is based on the AGHPB API. It is a simple Java Wrapper that allows you to interact with the API in a more convenient way.

Installation

To use this Wrapper, you need to add the following repository and dependency to your pom.xml file. Replace VERSION with the latest version seen above or found here.

<repositories>
    <repository>
        <id>joshicodes-de-releases</id>
        <name>JoshiCodes Repository</name>
        <url>https://repo.joshicodes.de/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>de.joshicodes</groupId>
        <artifactId>AGHPB4J</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

Usage

To use the API, you first need to create a new AGHPB object. You can do this by calling the constructor and passing the URL of the API as a parameter.

AGHPB aghpb = new AGHPB("http://localhost:5000");
// If no url is provided, the default public api will be used (https://api.devgoldy.xyz/aghpb/v1/)
AGHPB aghpb = new AGHPB();

After creating the object, just use one of the available methods. Almost every method, returns a RestAction Object. To execute the request, you need to call the #execute() method. This method is blocking and will return the result. If you want to execute the request asynchronously, you can use the #queue() method. This method will return void, but can take a Consumer as a parameter, which will be called when the request is completed.

AGHPB aghpb = new AGHPB();


AGHPBook book = aghpb.retrieveRandomImage().execute(); // Blocking
System.out.println(book.getUrl());
// or
aghpb.retrieveRandomImage().queue(book -> System.out.println(book.getUrl())); // Asynchronous

For more examples, see here.

Methods

• AGHPB#retrieveStatus() - ApiStatus Returns the status of the API.
• AGHPB#retrieveInfo() - ApiInfo Returns the info of the API.
• AGHPB#retrieveAllCategories() - List<String> Returns a list of all available categories.
• AGHPB#retrieveRandomImage(@Nullable String category, @Nullable AGHPBook.BookImageType type) - AGHPBook Returns a random image. Both parameters are optional and alternatively you can use the AGHPB#retrieveRandomImage() method without parameters or with only one parameter.
• AGHPB#retrieveSearch(String query) - List<AGHPBook> Returns a list of images that match the search query. Alternatively you can use AGHPB#retrieveSearch(String query, int limit), AGHPB#retrieveSearch(String query, int limit, int page) or AGHPB#retrieveSearch(String query, String category) or AGHPB#retrieveSearch(String query, String category, int limit).
• AGHPB#retrieveBook(int searchId) - AGHPBook Returns a book by its search id. Alternatively you can provide a BookImageType to specify the type of the image. Instead of the searchId, you can also provide an unfinished AGHPBook object, to retrieve its image.

You can find the full JavaDocs here.