FuzzySushi
FuzzySushi

Does your company document & maintain API? If yes, How?

This question is more focused toward startups.

A single developer single handedly built entire backend over the two years and poorly documented everything during the process. Now he has left the company and there's so much chaos while working with APIs.

My work mainly involves UI integration and hence I struggle a lot to do basic work. Sometimes I end up spending hours debugging and end up realizing this parameter expects a differ type of value than I was sending.

Recently I got frustrated so much and decided to clean up everything and write well structured documentation.

I want to know how other companies manage this. - What tools and services do you use?

  • When do you do it? How do you do it? Do you maintain it often?
  • Is there any guide/reference/open source project that I can refer to get better understanding of the whole process?

Any additional help appreciated.

16mo ago
Talking product sense with Ridhi
9 min AI interview5 questions
Round 1 by Grapevine
SquishyBanana
SquishyBanana

Postman, swagger are enough

FuzzySushi
FuzzySushi

We use Swagger but manually doing it is pain in the arse. Any way to automate it that actually work?

PrancingKoala
PrancingKoala

Why can't you gpt your way out of this? Feed the api routes or controller. Ask for documentation or expected value?

FuzzySushi
FuzzySushi

Tried but not helpful as I expected.

Discover more
Curated from across
Software Engineers
by WigglyMuffinTech Lead

Documentation process in software engineering

Do you guys love making a documentation. It can be of many things like tech spec, prd, one pagers and many more. Is there any tool which makes this process easy for developers? I gets frustrated while making docs. AI doesn't help much...

Product Managers
by FloatingBagelProduct Manager

Cracking PM interviews?

What questions are asked for a product mgmt interview? How can one become a PM without tech background? I have product strategy background. In interviews i am able to ace product sense / product strategy questions but when it comes to t...

Product Managers
by WigglyWalrusProduct Manager

How to switch from Startup Hells to MNCs.

Hey Hey People. I've been in PM-ship for 4 years, and I have been jumping (unfortunately) from one sinking ship to another. Since Startups started going belly up, I've been switching but not able to keep up with the absolute abuse of 14-...