From c5db3cc721d106d641f0982bf2ee55a031e7e3bf Mon Sep 17 00:00:00 2001 From: pierzeno Date: Fri, 19 Jul 2024 16:59:28 +0200 Subject: [PATCH] update readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1984cc1..a36fbbb 100644 --- a/README.md +++ b/README.md @@ -130,4 +130,13 @@ Parts of the tool that manage JWTs has been built using nimbus-jose-jwt # MIG-T API Documentation -Explore the API endpoints and documentation here: \ No newline at end of file +Explore the API endpoints and documentation here: + +### API Endpoints + +The APIs exposed by MIG-T have the following endpoints: `/users`, `/users/login`, `/messages`, and `/validation`. The first three APIs can be interacted with through the frontend exposed by MIG-T at the URL [http://localhost:3000](http://localhost:3000). + +- **/users**: Allows the user to register the username and password in MIG-T. +- **/users/login**: Allows the user to log in to MIG-T. +- **/messages**: Allows the user to send session & test data to MIG-T so that MIG-T can execute them and return the output. +- **/validation**: Allows the user to submit a test to MIG-T and check if it is valid. \ No newline at end of file