Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pierzeno committed Jul 19, 2024
1 parent ac9f836 commit c5db3cc
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://app.swaggerhub.com/apis-docs/PGSENO02/MIG-TAPIs/1.0.0#/>
Explore the API endpoints and documentation here: <https://app.swaggerhub.com/apis-docs/PGSENO02/MIG-TAPIs/1.0.0#/>

### 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.

0 comments on commit c5db3cc

Please sign in to comment.