Is there a way to convert a Swagger spec into Verint Community wiki pages like on this community?

Question

https://community.telligent.com/community/11/w/api-documentation/ 
 How is this documentation generated? I love the idea of using Verint Community to host API documentation for software products but how can this be achieved? For instance, if you have a Swagger spec, is there a way to automate the generation of wiki pages or is all this documentation done manually / by hand?

Michael Monteleone · Accepted Answer

REST endpoints are defined using the IRestEndpoints plugins, which support defining their own documentation. 
 In-process and script APIs consume an API-defined attribute, Telligent.Evolution.Extensibility.Version1.DocumentationAttribute, to decorate their methods and parameters. That data then powers the documentation inside the Widget, Theme, and Automation Studios. This is useful for third party plugins as well, as it only ever shows what's installed and enabled. 
 
 While these documentation methods are available to custom plugins. they aren't currently surfaced elsewhere in the platform. 
 For the static documentation in this community, we use a custom tool which reads those same attributes and then uses the REST wiki APIs to generate wiki pages. The tool is unfortunately not very generalizable -- but it also doesn't do that much. The same wiki pages could be generated using the REST wiki API against a parsed Swagger spec as well.

Is there a way to convert a Swagger spec into Verint Community wiki pages like on this community?

Top Replies