विवरण
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
स्थापना
- 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
समीक्षाहरू
यस प्लगिनको लागि कुनै समीक्षाहरू छैनन्।
योगदानकर्ता र डेभलपरहरू
“Document Generator for OpenAPI” खुला स्रोत सफ्टवेयर हो। निम्न व्यक्तिहरूले यो प्लगिनमा योगदान गरेका छन्।
योगदानकर्ताहरू“Document Generator for OpenAPI” लाई आफ्नो भाषामा अनुवाद गर्नुहोस्
विकासमा रुचि छ?
आरएसएस द्वारा कोड ब्राउज गर्नुहोस्, एसभीएन रिपजिटरी हेर्नुहोस्, वा विकास लग को सदस्यता लिनुहोस्।
चेन्जलग
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