Add REST API root resource #658

UnniKohonen · 2022-12-23T12:33:31Z

This PR adds a resource to the root of the REST API (i.e. http://<annif_host>/v1/) that gives basic information on the API. The information given is a title for the API and the version of Annif being used. The response is a json object with the format:

{
    "title": "Annif REST API",
    "version": "0.60.0"
}

Implements #655

codecov · 2022-12-23T12:36:53Z

Codecov Report

Base: 99.55% // Head: 99.55% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (a4e5be8) compared to base (45be34d).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #658   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files          87       87           
  Lines        6006     6017   +11     
=======================================
+ Hits         5979     5990   +11     
  Misses         27       27

Impacted Files	Coverage Δ
annif/rest.py	`96.55% <100.00%> (+0.18%)`	⬆️
tests/test_rest.py	`100.00% <100.00%> (ø)`
tests/test_config.py	`100.00% <0.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

osma · 2023-01-09T14:34:12Z

Looks good so far. A couple of suggestions:

black formatting should be applied to the dict returned by show_info (see details)
there should be a unit test in tests/test_rest.py checking that the show_info method returns what is expected