Here’s a complete and professional README.md file for the WP API Tester & Generator plugin:
Contributors: [gblessylva]
Tags: REST API, WordPress, API Testing, API Generator, Developer Tools
Requires at least: 5.5
Tested up to: 6.4
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
The WP API Tester & Generator plugin is a powerful tool for WordPress developers to create, test, and manage custom REST API endpoints. It streamlines the process of building robust APIs, offering features like endpoint customization, API testing, role-based access control, and more.
Whether you're developing complex web applications or simple integrations, this plugin enhances productivity by automating common API development tasks.
-
Custom Endpoint Generator
- Visually create and manage REST API endpoints.
- Support for multiple HTTP methods (GET, POST, PUT, DELETE).
- Role-based access control for endpoints.
-
API Testing Tools
- Built-in interface for testing endpoints directly from the WordPress dashboard.
- Save and reuse test cases.
- View detailed response logs.
-
Response Customization
- Control metadata visibility, apply filters, and enable conditional responses.
-
Mock API Responses (Pro)
- Generate mock responses to simulate endpoint behavior during development.
-
Documentation Automation (Pro)
- Automatically generate endpoint documentation in JSON or Markdown format.
- Developers: Simplify REST API development and testing.
- Agencies: Standardize and document API workflows for client projects.
- Site Owners: Create secure endpoints for custom integrations or third-party tools.
- Go to Plugins > Add New.
- Search for "WP API Tester & Generator".
- Click Install Now and then Activate.
- Download the plugin ZIP file.
- Upload the contents to the
/wp-content/plugins/wp-api-tester-generator/directory. - Activate the plugin through the Plugins menu in WordPress.
- Access the Dashboard: After activation, go to WP API Tester in your WordPress admin menu.
- Generate Endpoints: Use the visual interface to define new REST API endpoints.
- Test Endpoints: Navigate to the API Tester section, select an endpoint, and test it with various HTTP methods.
- Customize Responses: Fine-tune API responses using the customization panel.
-
Dashboard Overview
View active endpoints, test logs, and usage stats. -
Endpoint Generator
Easily create and manage custom endpoints with a drag-and-drop interface. -
API Tester
Test your endpoints and view live responses directly from WordPress. -
Documentation Automation (Pro)
Export endpoint documentation in JSON or Markdown.
A: Yes! You can assign specific user roles to each endpoint for secure access.
A: Absolutely. You can bind endpoints to custom queries, including custom post types and taxonomies.
A: Yes, the Pro version offers advanced features like mock responses, documentation generation, and more. Visit example.com for details.
- Initial release.
- Core features: Endpoint generation, API testing, and response customization.
- Basic role-based access control.
Unlock advanced features like:
- Mock API responses.
- Automated documentation generation.
- Enhanced testing tools.
- Integrations with WooCommerce, BuddyPress, and more.
Visit example.com to learn more and upgrade.
For questions, feature requests, or bug reports, please open an issue on GitHub or contact us at [email protected].
This README.md is structured for clarity and professionalism, covering everything from installation to features and support. Customize the links (e.g., example.com) as per your requirements.