Restsplain

Restsplain Super fast WordPress REST API docs that update with your site. A Human Made project. Maintained by @roborourke. The WordPress REST API provides much of it's own documentation via it's schema. This plugin contains a React app that consumes the schema data to generate a blazing fast documentation site. 1. Add and edit high level documentation pages 2. Automatic discovery and display of all custom endpoints 3. Make API requests direct from the documentation! Installation Upload the plugin to your plugins directory and activate it. You'll need to refresh your permalinks to use the built in URL by visiting the permalinks settings page in the admin. Once you've done that browse to http://your-site.com/api-docs/ and you're done! Configuration Hopefully you won't need to do much configuration with Restsplain however there are a number of filters you can use to change it's behaviour. Default URL The docs will by default show at /api-docs/ however you can modify this using the filter: Default content In the admin you'll see a new post type called "API Docs". Default pages will be created for you if you don't add any before visiting