Commit Graph

3 Commits (stevens_api)

Author SHA1 Message Date
Mike Benowitz 02b6462b9e Add flasgger to requirements.txt 2019-07-05 14:52:17 -04:00
Mike Benowitz d8f676c88f SFR-479 Add Basic API
Add a basic `Flask` API that responds to queries for copyright data. This includes 5 basic endpoints:

- `/search/fulltext`: queries all text fields in the Registration and Renewal records
- `/search/registration/<regnum>`: queries the collection for a specific copyright registration by registration number
- `/search/renewal/<rennum>`: queries the collection for a specific copyright renewal by renewal number
- `/registration/<uuid>`: fetches a single registration record by internally assigned UUID
- `/registration/<uuid?`: fetches a single renewal record by internally assigned UUID

The api can be run with the standard `python -m flask run` from the root of the project and by default will run in `production` mode. To set `development` run `export FLASK_ENV=development` before starting the application.
2019-06-04 16:43:08 -04:00
Mike Benowitz edd14d9cdb SFR-453 Initial Commit
Includes an initial version of the utility script used to generate
the copyright entry/renewal database along with instructions on how
to run the script and create a version of the database locally
2019-05-29 12:47:03 -04:00