Swagger descriptor for REST API with nice Swagger UI console. Nowadays, it is a standard de facto. Microservices should be accessible via HTTP and operate with data in a human-readable JSON format. As a bonus, it is super easy to generate data types and API client code for the client side (it works well for a TypeScript-based front-end, for example). - Source: dev.to / about 1 month ago

Often used for cases where a project exposes a REST or other type of API service. Open API is a popular method of documenting such API services. It can also be used along side tools such as Swagger Codegen to produce boilerplate code for API interaction / testing purposes. There may also be support files for popular API testing tools such as Postman or Insomnia. This makes it easier at a glance to see what data is... - Source: dev.to / 5 months ago

Regarding the IO, there could also be low-code tools. Swagger could be taken as inspiration. Swagger codegen is a great tool that allows you to declaratively produce code to interact with APIs. - Source: dev.to / 11 months ago

Personally I would try to put as much business logic as possible into your API that runs on server. Use a format like swaggger (https://swagger.io/tools/swagger-codegen/) to auto generate the client SDKs for every platform you support. Source: 12 months ago

It sounds like you want an OpenAPI spec. This can be written by hand or partially generated using a crate like utoipia. Once you have an OpenAPI spec you can generate clients in a myriad of languages using the (swagger codgen)[https://swagger.io/tools/swagger-codegen/] tools. Source: about 1 year 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 / 20 days 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: about 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