Description
StarRestGate seamlessly integrates a powerful, interactive Swagger UI dashboard directly into your WordPress admin area. Designed for developers who build and maintain WordPress REST APIs, it offers an instant, zero-configuration environment to visualize and securely test endpoints in real-time.
Current features are:
- Native Admin Experience: Features a clean, polished Swagger UI interface that blends seamlessly with the WordPress admin UI, making it feel like a core feature.
- 100% Client-Side Parsing: It dynamically queries the standard
wp-jsonendpoint using JavaScript. No server-side overhead, no heavy PHP parsing, and no guesswork. You see exactly what the outside world sees. - Zero-Configuration Testing: It safely leverages your active admin session and nonces. Test all standard HTTP verbs (GET, POST, PUT, DELETE) securely without configuring external tokens or OAuth.
- Production Safe & Invisible: The developer tools are strictly restricted to administrators. For regular visitors and production traffic, the plugin has zero impact and loads zero assets.
Third-Party Software
This plugin bundles the following third-party software:
* Swagger UI – https://github.com/swagger-api/swagger-ui (Licensed under the Apache License 2.0)
Screenshots
Installation
- Upload the plugin folders and files to the
/wp-content/plugins/star-rest-gatedirectory, or install it directly via the WordPress admin panel. - Activate the plugin through the ‘Plugins’ menu in WordPress.
- Navigate to the new “StarRestGate” menu item in your admin dashboard to launch Swagger UI.
FAQ
-
How does this differ from other approach to API documentation?
-
Most solutions approach API documentation from the inside out, using server-side logic to analyze and map the code structure. StarRestGate simply shifts the perspective: it looks at the system from the outside in. By letting WordPress natively handle its own REST structure, our tool acts purely as an observer on the client side. It pulls the live data directly through JavaScript and renders it in Swagger UI. It is just a different, lightweight way to view your active endpoints exactly as the client application encounters them.
-
Is there an impact on frontend performance?
-
No. The plugin only enqueues scripts and renders the iframe when an administrator explicitly opens the StarRestGate dashboard in the backend.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“StarRestGate” is open source software. The following people have contributed to this plugin.
Contributors
Translate “StarRestGate” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
0.1.0
- Initial release.
- Core Rest Endpoints utility with live Swagger UI client-side rendering.