As for the actual process of building the contract, what works well for me is using API Blueprint-style Markdown in a compatible tool like Apiary, which renders your content into Swagger-like documentation as you type. This way, I and others can mutually "live-scribe" the API contract as we discuss, and seeing it on-screen helps to get people on the same page (and sometimes highlight potential issues that would... Source: about 1 year ago

I’m not sure a JS library qualifies as a PL. Or automation software (SoftStack). Or an API description language. Or a build system. Source: over 1 year ago

Create a Proper API Documentation The following open-source projects can help you with creating documentation for your APIs: APIBluePrint Swagger. - Source: dev.to / over 1 year ago

A common complaint about OpenAPI is that it’s difficult to learn and to read. Consequently, over the years we’ve seen many alternatives to OpenAPI, such as RAML, WADL, API Blueprint, and others. The problem with many of these alternatives is that in most cases they aren’t really more readable or easier to learn. Simpler description languages also tend to support less capabilities for documenting API features.... - Source: dev.to / almost 2 years ago

For the context of this post, only the first task is essential. In it, the team works together to define the API contract. They discuss data format, whether the API will be Rest or RPC, authentication, data compression, and other vital issues. The delivery of this task is the documentation, preferably in a standard like OpenAPI or API Blueprint (my preferred format). - Source: dev.to / almost 2 years ago

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