Quick Start¶

This page shows how to create a WordPress REST Client instance and list WordPress posts.

Please note

Before you can use the WordPress REST Client, your WordPress must have the REST API authentication configured.

Endpoint Discovery¶

WordPress REST Client accepts a WordPress site URL rather than a REST API URL.

The client automatically discovers the REST API root using the standard WordPress REST API discovery mechanism and resolves all endpoint URLs from the discovered API index.

For example, provide the base site URL:

http://localhost:8080

The client discovers the REST API endpoint automatically.

List Posts with Apache HttpClient¶

Add the Apache implementation dependency:

Maven

pom.xml

<dependency>
    <groupId>io.github.evisentin</groupId>
    <artifactId>wp-rest-client-apache</artifactId>
    <version>::latest::</version>
</dependency>

Gradle (groovy)

build.gradle

dependencies {
    implementation 'io.github.evisentin:wp-rest-client-apache:<latest version>'
}

Gradle (kotlin)

build.gradle.kts

dependencies {
    implementation("io.github.evisentin:wp-rest-client-apache:<latest version>")
}

Then create the client and list posts:

import io.github.evisentin.wordpress.rest.client.adapter.apache.ApacheWpRestClientBuilder;
import io.github.evisentin.wordpress.rest.client.domain.api.WpRestClient;
import io.github.evisentin.wordpress.rest.client.domain.model.WpPagedResponse;
import io.github.evisentin.wordpress.rest.client.domain.model.WpPost;
import io.github.evisentin.wordpress.rest.client.domain.model.query.WpPaginationQuery;
import io.github.evisentin.wordpress.rest.client.domain.model.query.WpPostQuery;

import java.util.List;
import java.util.Set;

import static io.github.evisentin.wordpress.rest.client.domain.model.enums.WpPostStatus.DRAFT;
import static io.github.evisentin.wordpress.rest.client.domain.model.enums.WpPostStatus.PUBLISH;

final WpRestClient restClient =
        ApacheWpRestClientBuilder.basicAuthentication(
                "http://localhost:8080",
                "admin",
                "admin"
        ).build();

final WpPaginationQuery pageQuery = new WpPaginationQuery(1, 10);
final WpPostQuery postQuery = WpPostQuery.builder()
        .withStatuses(Set.of(DRAFT, PUBLISH))
        .build();

final WpPagedResponse<WpPost> response = restClient.posts().list(pageQuery, postQuery);
final List<WpPost> posts = response.getItems();

List Posts with OkHttp¶

Add the OkHttp implementation dependency: