转换器API的休息终点命名约定

Question

我正在实现一个休息点，将 banana 转换为橙色，但也将橙色转换为香蕉。

终点的适当命名是什么？

/conversions/banana/orange
/conversions/orange/banana

/conversions/banana2orange
/conversions/orange2banana

/conversions/bananatoorange
/conversions/orangetobanana

或其他东西？

Answer 1

我认为，休息是关于资源的。在这种情况下，资源是香蕉和橘子。例如，如果您认为可以通过ID检索香蕉或橙色，那么您的终点将是：

1. /oranges/{id}
2. /bananas/{id}

所以我不会制作/conversions端点，但是我会使用类似的东西：

1. /oranges/frombanana或/oranges/from_banana
2. /bananas/fromorange或/bananas/from_orange

无论如何，我真的不认为有一个很好的命名约定，因此我不会发现上面提出的任何端点很奇怪。无论如何，我没有发现前两个不言自明。/conversions/orange/banana做什么？它是将橙色转化为香蕉还是从香蕉中转化橙色？也许像/conversions/banana/to/orange这样的东西会更加自称。

仅供参考，这里是云存储服务的一些API：

1. dropbox apis：https：//www.dropbox.com/developers/documentation/http/documentation
2. box apis：https：//developer.box.com/reference

或paypal：https：//developer.paypal.com/docs/api/balance-accounts/