Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Added note about queries via the HTTP API

Browse Source
This commit is contained in:
troymc 2016-06-20 11:34:48 +02:00
parent 5ae231501c
commit d87f881eda
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/drivers-clients/http-client-server-api.md
View File

@ -1,11 +1,12 @@
# The HTTP Client-Server API # The HTTP Client-Server API
Note: The HTTP client-server API is currently quite rudimentary. For example, there is no ability to do complex queries using the HTTP API. We plan to add querying capabilities in the future. If you want to build a full-featured proof-of-concept, we suggest you use [the Python server API](../nodes/python-server-api-examples.html) for now.
When you start Bigchaindb using `bigchaindb start`, an HTTP API is exposed at: When you start Bigchaindb using `bigchaindb start`, an HTTP API is exposed at:
- [http://localhost:9984/api/v1/](http://localhost:9984/api/v1/) [http://localhost:9984/api/v1/](http://localhost:9984/api/v1/)
For security reasons, the server binds to `localhost:9984`.
Please note that for security reasons the server binds to `localhost:9984`.
If you want to bind the server to `0.0.0.0` we recommend you to read If you want to bind the server to `0.0.0.0` we recommend you to read
[Deploying Gunicorn](http://docs.gunicorn.org/en/stable/deploy.html) and [Deploying Gunicorn](http://docs.gunicorn.org/en/stable/deploy.html) and
follow the instructions to deploy it in production. follow the instructions to deploy it in production.
@ -14,5 +15,4 @@ The HTTP API currently exposes two endpoints, one to get information about a
specific transaction id, and one to push a transaction to the BigchainDB specific transaction id, and one to push a transaction to the BigchainDB
cluster. Those endpoints are documented at: cluster. Those endpoints are documented at:
- [http://docs.bigchaindb.apiary.io/](http://docs.bigchaindb.apiary.io/) [http://docs.bigchaindb.apiary.io/](http://docs.bigchaindb.apiary.io/)