API

Can I make you a request?

As we have mentioned the use case example is a Rest API (implemented twice). So we think the best way to document is reviewing all the http services.

URL

Method

Description

/api/v1/exchange/all

GET

Retrieves all exchange values

/api/v1/exchange/{year}/{month}/{day}

GET

Retrieves

the exchange for that day

/api/v1/exchange

POST

Creates a new exchange

/api/v1/exchange

PUT

Updates an existing exchange

/api/v1/exchange/{year}/{month}/{day}

DELETE

Deletes an existing exchange

/api/v1/program-scraping

POST

Programs a scraper to discover new values for exchanges

/api/v1/update-fees

POST

Runs a batch job for updating loan fees

Mmmm, the last two urls haven't great naming. Not HATEOAS at all. Can you help us? Is it easy to change? Do the tests help you to change these urls without thinking you are gonna break everything? Can I make you a request? Can you open a Pull Request?

Last updated

Was this helpful?