Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dkress59/wordpress-api-client
WordPress-API Client for JS/TS
https://github.com/dkress59/wordpress-api-client
api api-client client headless javascript json nodejs rest typescript wordpress wp
Last synced: about 18 hours ago
JSON representation
WordPress-API Client for JS/TS
- Host: GitHub
- URL: https://github.com/dkress59/wordpress-api-client
- Owner: dkress59
- License: mit
- Created: 2021-10-03T15:41:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T18:25:56.000Z (over 1 year ago)
- Last Synced: 2024-12-22T10:34:12.438Z (about 1 month ago)
- Topics: api, api-client, client, headless, javascript, json, nodejs, rest, typescript, wordpress, wp
- Language: TypeScript
- Homepage: https://dkress59.github.io/wordpress-api-client/
- Size: 100 MB
- Stars: 18
- Watchers: 1
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress-API Client
[](https://badge.fury.io/js/wordpress-api-client)
[](https://sonarcloud.io/summary/new_code?id=dkress59_wordpress-api-client)
[](https://sonarcloud.io/summary/new_code?id=dkress59_wordpress-api-client)
[](https://sonarcloud.io/summary/new_code?id=dkress59_wordpress-api-client)
A typed JavaScript client for your WordPress REST API. Super simple yet highly extensible.
This library covers all built-in WP REST API routes and can easily be extended
with custom routes. Fully integrated with [Advanced Custom Fields](https://advancedcustomfields.com).
---
## Installation
Depending on the package manager of your choice:
```bash
yarn add wordpress-api-client
```
```bash
npm install wordpress-api-client
```
---
## Quick Start
If you only need to access public REST routes from a vanilla WordPress installation,
all you need is:
```typescript
import WpApiClient from 'wordpress-api-client'
export const client = new WpApiClient('https://my-wordpress-website.com')
```
The next example shows how this bare setup, from above, will already cover most
of your needs:
```typescript
import WpApiClient, { WPCategory, WPPage, WPPost } from 'wordpress-api-client'
async function getContent(): Promise<{
aboutPage: WPPage
contactPage: WPPage
frontPage: WPPage
categories: WPCategory[]
recent25posts: WPPost[]
}> {
const client = new WpApiClient('https://my-wordpress-website.com')
const [aboutPage, contactPage, frontPage] = await client.page().find(12, 23, 34)
const categories = await client.postCategory().find()
const recent25posts = await client.posts().find(new URLSearchParams({
order: 'desc',
per_page: '25',
}))
return { frontPage, aboutPage, contactPage, categories, recent25Posts }
}
```
If you would like to extend the client, adding post types and REST end points is
as easy as you would expect (example from the [demo project](https://github.com/dkress59/wordpress-api-client/tree/demo)):
```typescript
import { CustomPost, WPMenu, WPProduct } from './types'
import WpApiClient, { DefaultEndpointWithRevision } from 'wordpress-api-client'
const EP_PRODUCTS = 'wp/v2/products'
const EP_MENU = 'demo-plugin/v1/menu'
export class WpClient extends WpApiClient {
constructor() {
super('http://localhost:8080', {
auth: {
type: 'basic',
password: 'password',
username: 'admin',
},
})
}
post
(): DefaultEndpointWithRevision
{
return super.post
()
}
public product(): DefaultEndpointWithRevision {
return this.addPostType(EP_PRODUCTS, true)
}
menu = this.createEndpointCustomGet(EP_MENU)
}
```
With this `WpClient` class, extended from this package's `WpApiClient` class,
you have full access to your WordPress's REST API, including your custom post
types, custom end points and Advanced Custom Fields:
```ts
import { WpClient } from './wp-client'
const client = new WpClient()
// custom end points
await client.menu()
await client.product().find()
await client.product().create()
await client.product().update()
await client.product().delete()
await client.product().revision().find()
await client.product().revision().create()
await client.product().revision().update()
await client.product().revision().delete()
// default end points
await client.siteSettings.find()
await client.taxonomy().find()
await client.page().find()
await client...
```
## Documentation
Feel free to report an [issue](https://github.com/dkress59/wordpress-api-client/issues)
if you are having trouble and the [documentation](https://dkress59.github.io/wordpress-api-client/)
is not helping.
## Contributors ✨
### Contributing Guidelines
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!
Please fork the upstream repository into your own account and apply your changes
to a new branch. Make sure to add tests, if necessary, before opening a PR against
the upstream main-branch.
Comment on an issue or on a PR and the
[all-contributors bot](https://allcontributors.org/docs/en/bot/usage) will add
you to the list above :)
