Create REST API - Githubissues

misaelvf2 / pykanji

MIT License

0 stars 0 forks source link

Create REST API #6

Closed misaelvf2 closed 2 years ago

misaelvf2 commented 2 years ago

We should specify and create a REST API to define all access to the underlying Kanji datastore.

Because we don't foresee the need to make frequent changes to the datastore, these will primarily be read operations.

These are roughly the steps that we need to perform:

[x] Create a web server with FastAPI
[x] Define the REST API with the OpenAPI specification (provided automatically by FastAPI)
[x] Define schemas for all ORM objects to allow serialization to JSON (provided automatically by FastAPI)
[x] Create handlers for all the API endpoints

misaelvf2 commented 2 years ago

Rest API added as of 8c64f91244b9ed679539fca81c3f7a67e9d44522.