How to generate API documentation from JSDoc annotated implementations

Maik Skoddow
Tera Patron
Tera Patron

Is there any build-in tool / application at ServiceNow that could generate automatically an API documentation based on my JSDoc annotated Script Includes?

 
6 REPLIES 6

sachin_namjoshi
Kilo Patron
Kilo Patron

You can use REST API explorer to generate API documentation like below

 

find_real_file.png

 

Regards,

Sachin

I'm afraid that is not what I have been looking for. Please see https://en.wikipedia.org/wiki/JSDoc 

Also note this does not "GENERATE" documentation, rather it takes you to the link, you provided in the API when you built it.  In OOB API's ServiceNow has added reference to their API docs. 

find_real_file.png

Daniel Oderbolz
Kilo Sage

Hi @Maik 

@Callum Ridley1 wrote SNDocs to that end: Introducing SNDoc - A better way to document your ... - ServiceNow Community

I hope you find that useful.

 


If this answer was helpful, I would appreciate if you marked it as such - thanks!

Best
Daniel