Euro <=> Dollar conversion endpoint naming convention-CodePudding

I have a question about a simple REST API endpoint.

The endpoint can accept a value expressed in EURO then returns the corresponding value in DOLLAR, conversely it can accept a value in DOLLAR an return the value in EURO.

I would like to know how I should name this endpoint to respect REST API endpoint naming conventions and best practices.

So far, I have thought about:

-convert-euro-dollar (Probably bad because it uses a verb)
-euro-dollar (Good option?)

Thanks in advance!

CodePudding user response：

As suggested by https://stackoverflow.com/a/48692503/19060474 and https://stackoverflow.com/a/10883810/19060474, I would go with one of

GET /dollar/from-euro
GET /euro/to-dollar
GET /currency/usd/from/usd
GET /currency/eur/to/usd

as long as you stay consistent.

Keep in mind, that you should be able to easily deduce from the endpoint what it will likely do. So you should make clear in which direction the conversion will be performed.
With euro-dollar or convert-euro-dollar this is not clearly expressed because one can not determine if the endpoint expects dollar (which dollar by the way, there are quite some variants like USD, AUD, CAD, ...) and converts to EUR or vice versa.
I also suggest you consider using currency codes from the ISO 4217 standard to avoid ambiguity. You can find some of them at https://www.iban.com/currency-codes.

CodePudding user response：

I would like to know how I should name this endpoint to respect REST API endpoint naming conventions and best practices.

REST doesn't care what naming conventions you use for your resource identifiers. (Hint: URL shorteners work.)

See Tilkov 2014.

The motivation for choosing "good" resource identifiers is much the same as the motivation for choosing "good" variable names -- the machines don't care, therefore you have extra degrees of freedom that you can use to make things easy for some people.

Possible people you might want to make things easy for: folks looking at resource identifiers in their browser history, operators looking at identifiers in HTTP access logs, writers trying to document the API, etc.

https://www.merriam-webster.com/dictionary/put

Verbs are fine; notice that this URL works exactly the way that you and your browser expect it to, even though the identifier includes a HTTP method.