We have finally released a Documentation WordPress Plugin for API endpoints today after months of testing and development.
PI API Documentation is a WordPress Plugin. This Plugin adds Custom Post Type Documentation which enables you to add Documentation for your REST API endpoints.
It is super easy to use and add API documentation quickly on your WordPress website. PI API Doc provides several Shortcodes, Widget area, Widget, CPT Doc Categories and tags which are custom taxonomies and options to control layout and related endpoints.
Here is the screenshot for settings panel.
You can check the PI API Doc Plugin in action here
The PI API Doc creates documentation CPT that allows you to add your REST API endpoints quickly and easily. You can display the listing in several ways, please check shortcodes for the details.
PI API Docs Features
- Plugin Options Panel
- Alphabetical Listing
- Categorized Listing
- Tagged Listing
- Short-codes available
- Number of Columns changeable
- Responsive Layout
- Sidebar Widget Available
- Related Items option
- Tested with latest version
Available Shortcodes
Place following shortcodes in the content area of any WordPress page/post/widget to display info.
- API Endpoints Listing –
{pi_api_doc]
- Documentation Categories –
{pi_api_doc_categories]
- Documentation Tags –
{pi_api_doc_tags]
- Endpoints Listing for any Category by ID –
{pi_api_doc parent_cat_id="ID_HERE"] e.g. {pi_api_doc parent_cat_id="267"]
- Endpoints Listing for any Category by slug –
{pi_api_doc parent_cat_slug="SLUG_HERE"] e.g. {pi_api_doc parent_cat_slug="cool-product"]
- Endpoints Listing for any Tag – {pi_api_doc tag_id=”ID_HERE”] e.g. {pi_api_doc tag_id=”27″]
{pi_api_doc tag_slug=”SLUG_HERE”] e.g. {pi_api_doc tag_slug=”endpoint_list”]
Buy PI API Documentation WordPress Plugin