Document Generator for OpenAPI
OpenAPI (fka. Swagger) Document Generator for WordPress REST API
Maintenance 20/100911d since update
Active installs
50
Downloads
6,883
Reviews
0
Age
4.3y
Tagsapirest-apigeneratorswaggeropenapi
Plugin info
Total downloads: 6,883
Active installs: 50
Total reviews: 0
Average rating: 0
Support threads opened: 0
Support threads resolved: 0 (0%)
Available in: 1 language(s)
Contributors: 1
Last updated: 7/4/2023 (911 days ago)
Added to WordPress: 9/21/2021 (4 years old)
Minimum WordPress version: 5.7
Tested up to WordPress version: 6.2.8
Minimum PHP version: 7.0
Maintenance & Compatibility
Maintenance score
Possibly abandoned • Last updated 911 days ago
20/100
Is Document Generator for OpenAPI abandoned?
Possibly abandoned (last update 911 days ago).
Compatibility
Requires WordPress: 5.7
Tested up to: 6.2.8
Requires PHP: 7.0
Similar & Alternatives
Explore plugins with similar tags, and compare key metrics like downloads, ratings, updates, support, and WP/PHP compatibility.
WP OpenAPI
Rating 3.7/5 (3 reviews) • Active installs 300
Embed Swagger UI
Rating 3.7/5 (3 reviews) • Active installs 100
Description
This plugin reads the schema definition of a given WordPress REST Api namespace and transforms it to a
OpenAPI document. The generator itself is exposed via the WordPress REST Api with the namespace document-generator-for-openapi/v1.
There is also a built in WP-CLI Command.
Limitations
- Beware that currently the generator is exposeed to anonymous users since the WordPress schema endpoint is also publicly
available. Use it at your own risk or disable the plugin after use. - No UI for configuration yet
- Currently only version 3.1.0 of the OpenAPI specification is implemented. Swagger tools for 3.0.0 might work though.
- Extensibility with hooks needs to be improved
Installation
- Install plugin via WordPress Plugin repository or by manually copying files
- Activate the plugin
- Access the REST Api of the generator by calling /wp-json/document-generator-for-openapi/v1/document?namespace=\<NAMESPACE> and your OpenAPI document will be returned.
- Or use the integrated WP-CLI command wp openapi-generator export-file
Frequently Asked Questions
No FAQ available
Review feed
No reviews available
Screenshots
No screenshots available
Changelog
1.1.0
- Added WP-CLI command to export OpenAPI document via CLI (Thanks to @vnmedeiros – Vinícius Nunes Medeiros)
1.0.2
- Added missing files for WordPress plugin repository
1.0.1
- Changed name of plugin from openapi-generator to document-generator-for-openapi
1.0.0
- Initial release