Bitshares ElasticSearch Wrapper and Swagger

in bitshares •  6 years ago 

In an effort to encourage the use of the elasticsearch-wrapper: https://github.com/oxarbitrage/bitshares-es-wrapper

Swagger apidocs was added to the api: http://185.208.208.184:5000/apidocs/#!/wrapper/

This was simply done by installing flasgger(https://github.com/rochacbruno/flasgger) and calling a yaml file from the wrapper.

You can check how flask app add flasgger support in the implementation commit: https://github.com/oxarbitrage/bitshares-es-wrapper/commit/89ed7c036dd83a530995641ae186fbcabbf308c5

Yaml file is where all the work is done, can be found for this project here: https://github.com/oxarbitrage/bitshares-es-wrapper/blob/master/wrapper.yaml

It needs some more work but i plan this to be implemented also in other apis of similar kind specifically: https://github.com/oxarbitrage/bitshares-python-api-backend

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

I'm all for that Swagger. Swaggy Swag. Swaggy Swag.