alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-12-26 06:24:29 +01:00
Code Releases Activity

README.md: Add notes about API endpoints

Browse Source
This commit is contained in:
Alan Orth 2018-09-25 11:28:12 +03:00
parent 93ae12e313
commit f30a464cd1
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -11,12 +11,21 @@ Create a virtual environment and run it:
$ pip install -r requirements.txt
$ gunicorn app:api
## Using the API
The API exposes the following endpoints:
- GET `/` — return views and downloads for all items that Solr knows about¹. Accepts `limit` and `page` query parameters for pagination of results.
- GET `/item/id` — return views and downloads for a single item (*id* must be a positive integer).
¹ We are querying the Solr statistics core, which technically only knows about all items that have either views or downloads.
## Todo
- Add API documentation
- Close up DB connection when gunicorn shuts down gracefully
- Better logging
- Return HTTP 404 when item_id is nonexistent
- Tests
## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).