arnaucube
/
hermez-node
mirror of https://github.com/arnaucube/hermez-node.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
345 Commits
26 Branches
2 Tags
32 MiB
 
 
 
Tree: 29f6d975d1
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '29f6d975d1'
${ noResults }
hermez-node/api
Arnau B 86029ca7de Improve swagger doc 4 years ago
..
README.md Swagger Review 4 years ago
account.go Refactor api pagination 4 years ago
account_test.go Integrate til into api 4 years ago
accountcreationauths.go Put api DBs into struct 4 years ago
accountcreationauths_test.go Account API 4 years ago
api.go API State RecommendedFee 4 years ago
api_test.go Integrate til into api 4 years ago
aux_test.go Add til api test first commit 4 years ago
batch.go Integrate til into api 4 years ago
batch_test.go Integrate til into api 4 years ago
bids.go Refactor api pagination 4 years ago
bids_test.go Integrate til into api 4 years ago
config.go Put api DBs into struct 4 years ago
config_test.go Put api DBs into struct 4 years ago
coordinator.go Refactor api pagination 4 years ago
coordinator_test.go Integrate til into api 4 years ago
docker-compose.yml Add GET histroy-transactions endpoint 4 years ago
exits.go Refactor api pagination 4 years ago
exits_test.go Integrate til into api 4 years ago
handlers.go Put api DBs into struct 4 years ago
parsers.go API state endpoint test 4 years ago
parsers_test.go API add bids endpoint 4 years ago
run.sh Add struct get state endpoint 4 years ago
slots.go Improve swagger doc 4 years ago
slots_test.go Integrate til into api 4 years ago
state.go Integrate til into api 4 years ago
state_test.go Integrate til into api 4 years ago
swagger.yml Improve swagger doc 4 years ago
token.go Refactor api pagination 4 years ago
token_test.go Integrate til into api 4 years ago
txshistory.go Refactor api pagination 4 years ago
txshistory_test.go Integrate til into api 4 years ago
txspool.go Put api DBs into struct 4 years ago
txspool_test.go Integrate til into api 4 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).