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.
257 Commits
26 Branches
2 Tags
19 MiB
 
 
 
Tree: 4eb2972b1b
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4eb2972b1b'
${ noResults }
hermez-node/api
ToniRamirezM b521a77fc5 API Coordinator Refactor 3 years ago
..
README.md Add GET histroy-transactions endpoint 4 years ago
api.go Impl account creation auth endpoints 3 years ago
api_test.go API Coordinator Refactor 3 years ago
batch.go Impl api get batch(es) 3 years ago
batch_test.go Impl api get batch(es) 3 years ago
coordinator.go API Coordinator Refactor 3 years ago
coordinator_test.go API Coordinator Refactor 3 years ago
dbtoapistructs.go API Coordinator Refactor 3 years ago
docker-compose.yml Add GET histroy-transactions endpoint 4 years ago
handlers.go API Coordinator Refactor 3 years ago
parsers.go Impl api get batch(es) 3 years ago
parsers_test.go Impl api get batch(es) 3 years ago
run.sh Add struct get state endpoint 3 years ago
state.go Add struct get state endpoint 3 years ago
swagger.yml Add struct get state endpoint 3 years ago
token.go API Update tokens endpoint 3 years ago
token_test.go API Coordinator Refactor 3 years ago
txshistory.go Impl api get batch(es) 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://loclahost: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).