# better-rest-endpoints
A WordPress plugin that serves up slimmer WP Rest API endpoints.

## Endpoints

### Posts
**`better-rest-endpoints/v1/posts`**
Gets a collection of posts. Accepts the following parameters:

- page (int)
- per_page (int)
- category id (int)
- category_name (string)
- tag id  (int)
- content (boolean) set to false to omit content from showing in JSON response
- orderby (string)
- order (string - 'ASC' vs 'DESC')
- exclude (int) a post ID to exclude from the response
- author (string) limit posts by author nice name (user_nicename)
- acf (boolean - setting to false omits `acf` from being returned)
- media (boolean - setting to false omits `media` (featured media) from being returned)

It returns a JSON response with the following:
- id
- slug
- title
- date (ISO 8601)
- excerpt
- content
- all possible thumbnail sizes & URL
- Author, user_nicename, & Author ID
- Categories
- Category IDs
- Tags
- Tag IDs
- ACF fields, if applicable

### Post
**`better-rest-endpoints/v1/post/{id}`**
Get a post by ID.

Accepts the following parameters:

- ID (int)

Returns a JSON response with the following:

- id
- slug
- title
- date (ISO 8601)
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- Categories
- Category IDs
- Tags
- Tag IDs
- ACF fields, if applicable

### Post by slug
**`better-rest-endpoints/v1/post/{slug}`**
Get a post by ID.

Accepts the following parameters:

- slug (string)

Returns a JSON response with the following:

- id
- slug
- title
- date (ISO 8601)
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- Categories
- Category IDs
- Tags
- Tag IDs
- ACF fields, if applicable

### Pages
**`better-rest-endpoints/v1/pages`**
Gets a collection of pages. Accepts the following parameters:

- exclude (int)
- orderby (string)
- order (string - 'ASC' vs 'DESC')
- per_page (int)
- page (int)
- content (boolean - setting to false hides the content from the response)
- exclude (int) a post ID to exclude from the response
- acf (boolean - setting to false omits `acf` from being returned)
- media (boolean - setting to false omits `media` (featured media) from being returned)

Returns the following JSON Response:

- ID
- Slug
- Template Name
- Title
- Content
- ACF Fields
- all possible thumbnail sizes & URLs

### Page by ID
**`better-rest-endpoints/v1/page/{id}`**
Get a page by ID.

Accepts the following parameters:

- ID (int)

Returns a JSON response with the following:

- id
- slug
- title
- template name
- content
- all possible thumbnail sizes & URLs
- ACF fields, if applicable

### Custom Post Type Collection
**`better-rest-endpoints/v1/{custom_post_type}`**
Gets a collection of posts from a custom post type. Accepts the following parameters:

- per_page (int)
- page (int)
- content (boolean - setting to false omits `the_content` from being returned)
- orderby (string) - see the [codex](https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters) for options, currently does not support multiple values
- exclude (int) a post ID to exclude from the response
- acf (boolean - setting to false omits `acf` from being returned)
- media (boolean - setting to false omits `media` (featured media) from being returned)

Returns the following JSON response:

- ID
- slug
- title
- date (ISO 8601)
- post terms
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- ACF fields if applicable

### Custom Post Type Post by ID
**`better-rest-endpoints/v1/{custom_post_type}/{id}`**
Gets a single custom post type item. Accepts the following parameters:

- ID

Returns the following JSON Response:

- ID
- slug
- title
- date (ISO 8601)
- post terms
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- ACF Fields, if applicable

### Custom Post Type Post by Slug
**`better-rest-endpoints/v1/{custom_post_type}/{slug}`**
Gets a single custom post type item. Accepts the following parameters:

- slug

Returns the following JSON Response:

- ID
- slug
- title
- date (ISO 8601)
- post terms
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- ACF Fields, if applicable

### Get Posts Belonging To A Taxonomy Term
**`better-rest-endpoints/v1/{taxonomy}/{term}`**
Gets posts from a taxonomy term. Accepts the following parameters:

- per_page (int)
- page (int)
- content (boolean - setting to false omits `the_content` from being returned)
- orderby (string) - see the [codex](https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters) for options, currently does not support multiple values
- exclude (int) a post ID to exclude from the response
- acf (boolean - setting to false omits `acf` from being returned)
- media (boolean - setting to false omits `media` (featured media) from being returned)

Returns the following JSON Response:

- ID
- slug
- title
- date (ISO 8601)
- post terms
- excerpt
- content
- all possible thumbnail sizes & URLs
- Author, user_nicename, & Author ID
- ACF Fields, if applicable

### Menus
**`better-rest-endpoints/v1/menus/{menu-slug}`**
Gets a WordPress Menu by slug. Accepts no parameters.

Returns the following JSON Response in each item object:

- ID
- menu_order
- title
- url
- slug
- target
- description
- classes (array)
- menu item parent

### Taxonomies
**`better-rest-endpoints/v1/taxonomies`**
Gets a list of taxonomies used by WordPress. Accepts no parameters.

Returns the following JSON response in each item object:

- Name
- Slug
- Description
- Hierarchical (true/false)

### Search
**`better-rest-endpoints/v1/search`**
Gets a collection of posts and pages based on the search parameter. Accepts the following parameters:

- page (int)
- per_page (int)
- category id (int)
- tag id  (int)
- content (boolean) set to false to omit content from showing in JSON response
- search (string | required)
- acf (boolean - setting to false omits `acf` from being returned)
- media (boolean - setting to false omits `media` (featured media) from being returned)

It returns a JSON response with the following (returns an empty array if no posts found):
- id
- slug
- title
- date (ISO 8601)
- excerpt
- content
- all possible thumbnail sizes & URL
- Author, user_nicename, & Author ID
- Categories
- Category IDs
- Tags
- Tag IDs
- ACF fields, if applicable