Leírás
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
Telepítés
- 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
Vélemények
Nincsenek értékelések erről a bővítményről.
Közreműködők és fejlesztők
“Document Generator for OpenAPI” egy nyílt forráskódú szoftver. A bővítményhez a következő személyek járultak hozzá:
Közreműködők
“Document Generator for OpenAPI” fordítása a saját nyelvünkre.
Érdekeltek vagyunk a fejlesztésben?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Változási napló
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