imageboard-api

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #go #golang #machine-learning #linux #docker #vue #security #mcp #ios #openai #open-source

(★ 55)

Simple asynchronous Java API wrapper around the most popular danbooru-compatible (Konachan, Yande.re, Danbooru, Gelbooru, etc) booru APIs.

imageboard-api 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ImageBoard (Booru) API

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.kodehawa/imageboard-api/badge.svg?style=flat&gav=true)](https://maven-badges.herokuapp.com/maven-central/io.github.kodehawa/imageboard-api)

ImageBoard API is a simple asynchronous Java API wrapper around the most popular danbooru-compatible booru APIs. Pretty much, it is a Booru library for Java.
The interface also supports other types of custom boards given a little tweaking. Releases are published in [Maven Central](https://central.sonatype.com/artifact/io.github.kodehawa/imageboard-api).

This helps you craft requests and search/fetch images on the danbooru-compatible imageboards (boorus) that exist out there.

#### Supported Booru Image Boards
 * Rule34 (*requires authentication*)
 * e621
 * Konachan
 * Yande.re
 * Danbooru
 * Safebooru
 * Gelbooru (*requires authentication*)
 * e926

Creating your own ImageBoard instance is possible, but would require a little tweaking.
    Please refer to the `ImageBoards.java` and `CustomBoard.java` to set up boards that are not included
    with this library. The boorus listed above are available by default with no further configuration required by the user.

## Adding ImageBoardAPI to your project
imageboard-api is available in Maven Central (Sonatype). Check [the Sonatype respository](https://central.sonatype.com/artifact/io.github.kodehawa/imageboard-api) for more information

#### Gradle
```groovy
repositories {
    mavenCentral()
}

dependencies {
    implementation 'io.github.kodehawa:imageboard-api:3.0.0'
}
```

## Set Up
There is a `ImageBoards` class located under utils, that one contains static, pre-created 
    ImageBoardAPI objects for you, but you can roll your own.

### Implementation
You can find implementation details and a lot of examples in the [tests for this project](https://github.com/Kodehawa/imageboard-api/blob/master/src/test/java/net/kodehawa/lib/imageboards/ImageBoardTest.java) and in [Mantaro](https://github.com/Mantaro/MantaroBot/blob/master/src/main/java/net/kodehawa/mantarobot/commands/image/ImageboardUtils.java#L54)

The User-Agent must be initialized to make requests. You can initialize it with `ImageBoard.setUserAgent()`. The default one was blocked by most imageboards, setting your own is the best to avoid UA blocking.

If a board requires authentication, you can provide a `BoardAuthorizationProvider` when constructing `ImageBoard`.  
The provider is called in two stages:
1. URL stage (`applyToUrl`) to inject query/path auth
2. Request stage (`applyToRequest`) to inject headers

For simple cases, use the built-in helpers like `HeaderAuthorization` or `UrlParameterAuthorization`.

**Note**: This only really applies to custom boards, the default ones either don't require authentication or have a simplified
construction method that just enables you to pass the required credentials without needing to worry about the auth provider.

## Examples
### Random Images
```java
import net.kodehawa.lib.imageboards.entities.BoardImage;
import net.kodehawa.lib.imageboards.DefaultImageBoards;

public class RandomImages {
    public static void main(String[] args) {
        // Asynchronous GET
        // 60 random images
        DefaultImageBoards.KONACHAN.get().async(images -> {
            for (BoardImage image : images) System.out.println(image.getURL());
        });
        
        // Asynchronous GET
        // 30 random images
        ImageBoards.KONACHAN.get(30).async(images -> {
            for (BoardImage image : images) System.out.println(image.getURL());
        });

// Blocking GET
        // 5 random image
        BoardImage image = DefaultImageBoards.KONACHAN.get(5).blocking().get(0);
        System.out.println(image.getURL());
        System.out.println(image.getRating());
        System.out.println(image.getTags());
        System.out.println(image.getHeight());
        System.out.println(image.getWidth());
        
        // Authenticated image board calls
        BoardImage image = DefaultImageBoards.createGelbooru("authToken","userId").get(5).blocking().get(0);
    }
}
```

### Image Tag Search
```java
import net.kodehawa.lib.imageboards.entities.BoardImage;
import net.kodehawa.lib.imageboards.DefaultImageBoards;

public class TagImages {
    public static void main(String[] args) {
        // Asynchronous GET
        // 20 images tagged with animal_ears
        DefaultImageBoards.KONACHAN.search(20, "animal_ears").async(images -> {
            for (BoardImage image : images) System.out.println(image.getURL());
        });

// Blocking GET
        // 60 images tagged with animal_ears
        BoardImage image = DefaultImageBoards.KONACHAN.search("animal_ears").blocking().get(0);
        System.out.println(image.getURL());
        System.out.println(image.getRating());
        System.out.println(image.getTags());
        System.out.println(image.getHeight());
        System.out.println(image.getWidth());
    }
}
```

### Filter bad results

You might want to filter BoardImage#isPending, as the tags/rating of those is almost guaranteed to never be correct.

For filtering other results, you can filter tags from BoardImage#getTags and use a .contains call on the list.

imageboard-api

imageboard-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

imageboard-api

imageboard-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README