arnaucube
206c8e6e8f
|
3 years ago | |
|---|---|---|
| .. | ||
| apitypes | 3 years ago | |
| stateapiupdater | 3 years ago | |
| README.md | 4 years ago | |
| account.go | 3 years ago | |
| account_test.go | 3 years ago | |
| accountcreationauths.go | 3 years ago | |
| accountcreationauths_test.go | 4 years ago | |
| api.go | 3 years ago | |
| api_test.go | 3 years ago | |
| aux_test.go | 4 years ago | |
| batch.go | 3 years ago | |
| batch_test.go | 3 years ago | |
| bids.go | 3 years ago | |
| bids_test.go | 3 years ago | |
| config.go | 3 years ago | |
| config_test.go | 3 years ago | |
| coordinator.go | 3 years ago | |
| coordinator_test.go | 3 years ago | |
| docker-compose.yml | 4 years ago | |
| exits.go | 3 years ago | |
| exits_test.go | 3 years ago | |
| handlers.go | 3 years ago | |
| parsers.go | 3 years ago | |
| parsers_test.go | 3 years ago | |
| run.sh | 4 years ago | |
| slots.go | 3 years ago | |
| slots_test.go | 3 years ago | |
| state.go | 3 years ago | |
| state_test.go | 3 years ago | |
| swagger.yml | 3 years ago | |
| token.go | 3 years ago | |
| token_test.go | 3 years ago | |
| txshistory.go | 3 years ago | |
| txshistory_test.go | 3 years ago | |
| txspool.go | 3 years ago | |
| txspool_test.go | 3 years ago | |
README.md
Hermez API
Easy to deploy and scale API for Hermez operators. You will need to have docker and docker-compose installed on your machine in order to use this repo.
Documentation
As of now the documentation is not hosted anywhere, but you can easily do it yourself by running ./run.sh doc and then opening the documentation in your browser
Mock Up
To use a mock up of the endpoints in the API run ./run.sh doc (UI + mock up server) or ./run.sh mock (only mock up server). You can play with the mocked up endpoints using the web UI, importing swagger.yml into Postman or using your preferred language and using http://localhost:4010 as base URL.
Editor
It is recomended to edit swagger.yml using a dedicated editor as they provide spec validation and real time visualization. Of course you can use your prefered editor. To use the editor run ./run.sh editor and then opening the editor in your browser.
Keep in mind that you will need to manually save the file otherwise you will lose the changes you made once you close your browser seshion or stop the server.
Note: Your browser may cache the swagger definition, so in order to see updated changes it may be needed to refresh the page without cache (Ctrl + Shift + R).