This commit is contained in:
@@ -48,6 +48,16 @@ The project is packaged as a Docker container, making it easy to deploy. You can
|
||||
* Bruno
|
||||
Bruno is used for testing the backend API endpoints. It is a simple HTTP client that allows you to send requests to the backend and view the responses. I used the OpenAPI specification to generate Bruno tests for each endpoint.
|
||||
|
||||
* Authentication
|
||||
|
||||
The backend exposes public ~/api/auth/register~ and ~/api/auth/login~ endpoints. The website has a login page only; users are created through the API, then the login page stores the returned JWT in the browser.
|
||||
|
||||
Protected requests include:
|
||||
|
||||
#+begin_src text
|
||||
Authorization: Bearer <jwt-token>
|
||||
#+end_src
|
||||
|
||||
* Future?
|
||||
** Integration with ~notes.zainezq.com~
|
||||
As the API is primarily used by ~zainezq.com~, I want to think of ways that ~notes.zainezq.com~ could also use it. This website is used to store all my notes, and they are exported using ~org-publish~ in Emacs. Perhaps I could write an Emacs Lisp package that interacts with the backend API to store and retrieve notes.
|
||||
|
||||
Reference in New Issue
Block a user