[oXygen-user] [ANN] The OpenAPI Documentation Generator add-on is available as of now!

Alin Belu alin_belu at oxygenxml.com
Fri Dec 24 08:04:31 CST 2021


Hello everyone,

We announce the release of the newest addition to Oxygen add-on library 
– the *OpenAPI Documentation Generator add-on*!

This tool is used for generating documentation for OpenAPI components in 
HTML format, including annotations and cross-references. The 
documentation displays information about the servers, paths, components, 
and tags defined in the OpenAPI documents and it is presented in a 
visual diagram style with various sections, hyperlinks, and filtering 
options.

To install the add-on, follow these instructions:
* Go to *Help* > *Install new add-ons* to open an add-on selection 
dialog box.
* Enter or paste 
https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the 
Show add-ons from field or select it from the drop-down menu.
* Select the *OpenAPI Documentation* add-on and click Next.
* Read the end-user license agreement. Then select the *I accept all 
terms of the end-user license agreement* option and click *Finish*.
* Restart the application.

To use the tool, select OpenAPI Documentation from the *Tools *> 
*Generate Documentation* menu. This opens a dialog box where you can 
specify the location of the OpenAPI file and HTML output file.

*Important:* The add-on is free and is compatible with any *Oxygen XML 
Editor/Developer version 24.0 and newer*.

For more information on the OpenAPI Documentation Generator add-on, 
please make sure to check the following page:
https://www.oxygenxml.com/doc/versions/24.0/ug-editor/topics/openapi-documentation-generator.html 


We hope you will find this new addition to our add-on library useful and 
as always, your feedback is welcome!

Best regards,
Alin

-- 
Alin Belu
Oxygen XML Editor
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20211224/76f68479/attachment.html>


More information about the oXygen-user mailing list