email_newsletter_api/docs/technical_write_up.md

# 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)
feat(docs): Added docs 2024-03-29 23:45:33 -04:00			`# Technical Write Up`

			`## Routes`

			- `health_check`: returns a HTTP code 200 if the server is up and running. Response body is empty.
feat: `subscribe` API route skeleton - Added `serde` crate for serialisation or deserialisation of data - Added test cases for the `subscribe` API route - Refactor the testing setup to another module `test_utils` - use random TCP port for testing 2024-04-22 17:00:55 -04:00			- `subscribe` returns a HTTP code 200 if the user successfully subscribed to our email newsletter service. 400 if data is missing or invalid.
feat(docs): Added docs 2024-03-29 23:45:33 -04:00
feat(docs): reorganized docs 2024-05-04 11:34:20 -04:00			`## Other topics`
feat(docs): Added docs 2024-03-29 23:45:33 -04:00
feat(docs): reorganized docs 2024-05-04 11:34:20 -04:00			`- [Database (PostgreSQL)](./database.md)`
			`- [Testing](./technical_write_up.md)`
			`- [Actic-web](./actix_web.md)`
			`- [tokio](./tokio.md)`