What do you use for planning out your API/endpoint structure?
Hi,
I’m sort of a visual-learner and work better when I have a visualization.
Are there any tools out there anyone uses or knows of which a developer can make use of for planning out an API?
I would want to plan out each endpoint with certain details on how it would work and whatnot.
The only service I can think of is Postman, but I was curious to know if there are better alternatives.
Thanks for any help.
11 Replies
I just wing it ¯\_(ツ)_/¯
You could write an OpenAPI spec tho
You can then use it to generate all the stubs for your actual endpoints, and even clients for wherever you're gonna use them
I usually generate the spec from the endpoints, and client from the spec, but there's nothing stopping you from generating everything from the spec
I like to just write out all my routes in a .http file at first which gives me a decent overview. Later on this evolves to a full .http file with calls for debugging
.http files are nice too, yeah. Especially with pretty much every IDE/editor supporting them nowUnknown User•2mo ago
Message Not Public
Sign In & Join Server To View
Be the change you want to see, write a source generator for it :when:
Unknown User•2mo ago
Message Not Public
Sign In & Join Server To View
i don't really know how you could "visualize" endpoints...
i could use a mindmap or mainly write an md to clear my mind about it
my bad
forgot about this
💀
thanks for the suggestions
I was just looking for a way to perhaps add details on what will be accepted (such as a body or what query parameters will be allowed, etc) and to write other notes on what it's for, etc
ok but then why using code (and at most markdown) would not be enough
If it's for documentation that others will read and use, use an openapi document
I don’t know. I just think it’d be a bit easier for me if there was a centralized tool for it. That way, I can go back to that centralized tool to look over what needs to be done based on what is planned
I’ll look into that, thanks. It’d mainly just be for me, though