You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I checked out the api documentation and couldn't find a way to get the modules and methods in a machine readable way. However typedoc states that you can generate json from the comments.
Could we add json somehow, maybe for something like
An alternative could be something like swagger, which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!
The text was updated successfully, but these errors were encountered:
Maybe I'll just give some background why I opened this issue.
While looking at the docs/example page (default local link is http://127.0.0.1:12315/) I got the idea to write an api client which derives its capabilities automatically from the docs/out.json. Then you wouldn't have to read the docs but have autocompletion and could validate commands before they are sent. (Edit: just wondering: could this be done genericly if typedoc permits this?)
I know there are other projects doing this, and it seems like a good idea. I even did this once by parsing html, and while it worked (and showed some errors in the documentation/api (depending on your pov) btw), but that is a route I never want to take again.
Edit: I "remembered" the project I liked, it is a wrapper/lib for tmdb: tmdbsimple. It looks pretty generic and is a "One-to-one mapping between tmdbsimple methods and TMDb endpoints."
I checked out the api documentation and couldn't find a way to get the modules and methods in a machine readable way. However typedoc states that you can generate json from the comments.
Could we add json somehow, maybe for something like
it could just be:
An alternative could be something like swagger, which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!
The text was updated successfully, but these errors were encountered: