DOGapp is a modelless Django application exposing REST API for DOGlib functionalities. Its goal is to provide fair access to CLARIN resources from the metadata by exposing both UI interface and API endpoints.
API also available via Swagger UI
PID's can be passed as parameters to URL query in following formats:
?pid=val1&pid=val2&pid=val3
?pid=val1,val2,val3
?pid[]=val1&pid[]=val2
Available endpoints:
/api/v1/openapi.json, provides OpenApi 3.0 specification of the API.
/api/v1/sniff/?pid, Checks whether PID points to resources in registered repository.
/api/v1/fetch/?pid, Fetches all PIDs referenced in the metadata, supports PID and list of PIDs to metadata in formats.
/api/v1/identify/?pid, identifies PID (VLO request).
/api/v1/repostatus/, dictionary with Registered Repositories as keys and PID:status pairs
Install DOG by running following commands in the project's root dir:
pip install .In order to run the unittests simply run
python ./runtests.pyin the project's root directory. The script will take care of providing minimal testing configuration and testing all the applications
To start the project local installation of dogapi and dogui is required, config can be spinned from source by running
python ./dogconfig/manage.py runserverBy default DOG homepage should be available at your localhost:8000 and API endpoints at localhost:8000/api/<functionality>