email_newsletter_api/docs/technical_write_up.md

14 lines
422 B
Markdown

# Technical Write Up
## Routes
- `health_check`: returns a HTTP code 200 if the server is up and running. Response body is empty.
- `subscribe` returns a HTTP code 200 if the user successfully subscribed to our email newsletter service. 400 if data is missing or invalid.
## Other topics
- [Database (PostgreSQL)](./database.md)
- [Testing](./technical_write_up.md)
- [Actic-web](./actix_web.md)
- [tokio](./tokio.md)