An open API service indexing awesome lists of open source software.

https://github.com/baradatipu/rest-api-plugin-for-wordpress

It's a Open Source Plugin For Wordpress REST API
https://github.com/baradatipu/rest-api-plugin-for-wordpress

php rest-api wordpress-plugin

Last synced: 12 months ago
JSON representation

It's a Open Source Plugin For Wordpress REST API

Awesome Lists containing this project

README

          

# WordPress REST API Plugin

This WordPress plugin aims to provide a robust REST API, facilitating the development of Android apps or any other software requiring interaction with WordPress-based websites. With this plugin, developers can easily access and manipulate WordPress data programmatically, enabling seamless integration with various platforms and applications.

## Features

- Exposes WordPress data through a RESTful API.
- Supports CRUD operations (Create, Read, Update, Delete) for posts, pages, categories, tags, and more.
- Authentication mechanisms for secure API access.
- Customizable endpoints to suit specific project requirements.
- Simple configuration and setup process.

## Usage

To use this plugin:

1. Clone this repository to your local machine or server.
2. Upload the plugin files to the `/wp-content/plugins/` directory.
3. Activate the plugin through the 'Plugins' menu in WordPress admin.

Once activated, you can start using the REST API endpoints to interact with your WordPress site programmatically. Here are some common operations:

- **Fetching Posts**: `GET /wp-json/wp/v2/posts`
- **Creating a Post**: `POST /wp-json/wp/v2/posts`
- **Updating a Post**: `PUT /wp-json/wp/v2/posts/{id}`
- **Deleting a Post**: `DELETE /wp-json/wp/v2/posts/{id}`
- **Fetching Pages**: `GET /wp-json/wp/v2/pages`
- **Creating a Page**: `POST /wp-json/wp/v2/pages`
- **Updating a Page**: `PUT /wp-json/wp/v2/pages/{id}`
- **Deleting a Page**: `DELETE /wp-json/wp/v2/pages/{id}`

Refer to the [official WordPress REST API documentation](https://developer.wordpress.org/rest-api/) for detailed information on available endpoints and parameters.

## Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`).
6. Create a new Pull Request.

### Contributors

[
baradatipu](https://github.com/baradatipu)

## Technical Skills Required

To contribute or work with this project, you should be familiar with:

- WordPress development
- RESTful API concepts
- PHP programming language
- JSON data format

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

**Note:** This project is still under development. Feedback, bug reports, and feature requests are highly appreciated. Thank you for your interest and support!