Nemory is a full REST API built with flask to manage an application for memorizing English vocabulary for Spanish speakers. It is the first test version developed for the BACKEND-DEVELOPMENT course taught by REDI.
## Initialize database and migrations #### before run the app, please run below command
flask db init - this will create a folder inside the app directory.
flask db migrate - this will create all the migrations.
flask db upgrade
For running Nemory, type the following:
python main.py
| HTTP Verb | Url Path | Description | Comments |
|---|---|---|---|
| POST | /nemory/api/v1.0/user/login | URL to read a collection of word | Payload: Json with name and password:  Response ok:  |
Use of header token for endpoints with security:
| HTTP Verb | Url Path | Description | Comments |
|---|---|---|---|
| GET | /nemory/api/v1.0/words | URL to read a collection of word | public access |
| GET | /nemory/api/v1.0/word?word=term | URL to read a single word filter by word | public access query string: term result ok:  not found the term:  |
| GET | /nemory/api/v1.0/word?category=verb | URL to read a list of words filter by category | public access query string: category result ok:  not found the category: |
| GET | /nemory/api/v1.0/users | URL to read a collection of users | token access result ok:  |
| GET | /nemory/api/v1.0/user/id | URL to read an user detail by id | token access |
| POST | /nemory/api/v1.0/user | URL to create new user | public access payload to create a new user:  name and email must be unique if ok we receive the object of the new user |
| PUT | /nemory/api/v1.0/user/id | URL to update an user filtered by id | token access You can update the following fields: name, lastname, email or password all or just the ones you need example payload to upload user:  |
| DELETE | /nemory/api/v1.0/user/id | URL to delete an user filtered by id | token access |
| GET | /nemory/api/v1.0/activities | URL to read a collection of activities | token access activities:  |
| POST | /nemory/api/v1.0/activity | URL to to create new activity | token acces payload new activiy:  result ok:  When the action is "ask" and the payload is correct, it returns result: True, otherwise False |
| GET | /nemory/api/v1.0/activity /nemory/api/v1.0/activity?action=ask |
URL to to create new activity. Allowed filters parametres: 'id_user','term','result(0 "false" or 1 "true")' and 'action' |
token access |