Integrating DocFX website content into a third party system

[vdruz-fidus]

Hi,

We have a C# DLL project with DocFX-based API documentation, and we'd like to integrate a third party system with the DocFX output, such that it could fetch the auto-generated class and method documentation, and present it to the user through its GUI. This system allows constructing sequences of API calls, and we want to interactively show the API documentation in a pop-up window, so it's easier to navigate the API.

For example, if there's a C# class Foo with method Bar(), which takes arguments x,y,z, our auto-generated DocFX page describes the arguments meaning, types, has links to min/max constants, etc. We want to get this data (e.g in JSON or XML format), parse it and show to the user.

AFAIK one way to do this would be integrating an iframe with fixed URL, but unfortunately the system doesn't have web browser capabilities. What we need is more like a web API interface, for searching the method documentation by method name.

Would something like that be possible with DocFX? And if not, is there a chance for this feature in the future?

Thanks in advance!
Vlad