JavaScript (TypeScript) ecosystem has various types of API docs generators. Maybe the most popular one is TypeDoc. While generating API docs itself is easy, hosting API docs is pretty hard. Publishing generated HTML to static hosting service like GitHub Pages is the method I adopted previously, but it's not an ideal solution because we can't view docs for older versions. - Source: dev.to / about 1 month ago

Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it. - Source: dev.to / about 1 year ago

Since you're using TypeScript, use TypeDoc. Source: about 1 year ago

I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools? Source: over 1 year ago

JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool. Source: over 1 year ago

This happened when I was working for one of my previous employers. I had just joined the company and was working on a microservice that was consuming a REST api exposed by another microservice. There was this JIRA ticket I was working on and I was not sure about the data model exposed by this REST api call. At this point in time the adoption to OpenAPI / Swagger / RAML was just beginning. I was new and was... - Source: dev.to / over 2 years ago

Provide consistent and easy-to-use documentation. Provide an OpenAPI or RAML file that describes your API and the endpoints. Also, provide easy-to-use interactive online API documentation like Swagger if possible. - Source: dev.to / almost 3 years ago