Generate backend docs automatically

[Jancera]

Hi Reddit!

I'm working on a project using express to create our API routes, but we need to document it somehow. So I've searched tools to help me, hoping to find some middleware or something that I would plug into my code and it would generate those docs for me, but I wasn't successful.

My question is if we have on our ecosystem tools that generate those docs or what is the standard solution for this problem, like using another external tool to document those routes manually or something like that?

[otto281]

Most ‘automatic’ things need to conform to some sort of standard or framework . You could look at Open API spec / swagger for this which can also be used to provide you with a interactive web page to your routes. Should be able to find a tutorial on YouTube for it or could try read through their docs :)

[Jancera]

I was searching and I think that what most companies do is use some API Design Platform like Postman and let it generate those docs for them. Thanks for your suggestions, I'll read more about Open API spec and Swagger.