Remix.run Logo
spiderfarmer 2 hours ago

Why would anyone need docs.

_heimdall 2 hours ago | parent [-]

REST is self documenting.

Edit: for down voters, I'd be curious why.

electroly 7 minutes ago | parent | next [-]

Not one of the downvoters, but I'd guess it's because this is only true with HATEOAS which is the part that 99% of teams ignore when implementing "REST" APIs. When people say REST they almost never mean HATEOAS even though they were explicitly intended to go together. Today "REST" just means "we'll occasionally use a verb other than GET and POST, and sometimes we'll put an argument in the path instead of the query string" and sometimes not even that much. If you're really doing RPC and calling it REST, then you need something to document all the endpoints because the endpoints are no longer self-documenting.

jermaustin1 20 minutes ago | parent | prev [-]

I didn't downvote, but I'm thinking that you need endpoint discovery, bucket types, etc. Sure you could write a 1 page document describing the buckets at the root level, the relationships of the objects, etc., but why not let swagger do that for you at compile time?