Create API/README.md

src/API/Middlewares/README.md

@@ -0,0 +1,17 @@
+# API Middlewares
+
+## HttpExceptions
+
+This middleware is responsible for converting exceptions thrown in the API module into HTTP responses.
+
+If there's an error this middleware has no knowledge of, `Internal Server Error` is returned.
+
+No other file in the module should have knowledge about HTTP response statuses.
+
+## Logger
+
+Adds the passed logger to KOA's `context`, making it available to other middlewares.
+
+## RequestValidation
+
+Adds Joi validation to API endpoints.

src/API/README.md

@@ -0,0 +1,13 @@
+# API
+
+This module manages the HTTP API of the Po.et Node.
+
+It has a close relationship with the View module: the View module is in charge of listening to different RMQ messages to build the state of the Po.et Node that is exposed to the world and the API module is in charge of actually exposing it to the world.
+
+As such, API is the only module that has direct access to another module's DB: the View's module. This access is read-only.
+
+For write operations (`POST` requests), the API broadcasts a RMQ message signaling the user's intent and immediately returns an ACK.
+
+## Middlewares
+
+See [/middlewares](./Middlewares).