hydrus is a set of Python based tools for easier and efficient creation of Hypermedia driven REST-APIs. hydrus utilises the power of Linked Data to create a powerful REST APIs to serve data. hydrus uses the Hydra(W3C) standard for creation and documentation of it's APIs.
docker-compose up --build
http://localhost:8000/api/vocab
You should be displaying the example API as served by the server.
To serve your own Hydra-RDF documentation file:
doc.py
file as the ones in examples/
directory containing your own ApiDocAPIDOC_REL_PATH
variable in docker-compose.yml
. This should the relative path from the project rootYou should be displaying your API as served by the server.
hydrus supports the following features:
The system is built over the following standards and tools:
Apart from this, there are also various Python packages that hydrus uses. Using python setup.py install
installs all the required dependencies.
NOTE: You'll need to use python3
not python2
.
To run a demo for hydrus using the sample API, just do the following:
Clone hydrus:
git clone https://github.com/HTTP-APIs/hydrus
Change directory and switch to the develop branch:
cd hydrus
git checkout -b develop origin/develop
Install hydrus using:
pip3 install -r requirements.txt
python3 setup.py install
and run the server using:
hydrus serve
The demo should be up and running on http://localhost:8080/serverapi/
.