There are "standards" about REST and other mental frameworks about API's but when it comes down to it, everything is slightly different since there are so many small decisions that affect the end product like pagination and authorization.
Documentation with working examples someone can use via curl or Postman (or other API poking tool) is even better.
Tech stack doesn't matter, REST, GraphQL, micro services, etc. doesn't matter. People are calling an API to get some work done, they just want to know how to work with it - inputs, what happens and outputs.
2 comments
[ 2.7 ms ] story [ 14.2 ms ] threadThere are "standards" about REST and other mental frameworks about API's but when it comes down to it, everything is slightly different since there are so many small decisions that affect the end product like pagination and authorization.
Documentation with working examples someone can use via curl or Postman (or other API poking tool) is even better.
Tech stack doesn't matter, REST, GraphQL, micro services, etc. doesn't matter. People are calling an API to get some work done, they just want to know how to work with it - inputs, what happens and outputs.