diff --git a/Readme.md b/Readme.md index d8d08cf..80bdbae 100644 --- a/Readme.md +++ b/Readme.md @@ -34,6 +34,19 @@ mvn spring-boot:run The server will start at . +## Exploring the Rest APIs + +The application defines following REST APIs + +``` +1. GET /tweets - Get All Tweets +2. POST /tweets - Create a new Tweet +3. GET /tweets/{id} - Retrieve a Tweet by Id +3. PUT /tweets/{id} - Update a Tweet +4. DELETE /tweets/{id} - Delete a Tweet +4. GET /stream/tweets - Stream tweets to a browser as Server-Sent Events +``` + ## Running integration tests The project also contains integration tests for all the Rest APIs. For running the integration tests, go to the root directory of the project and type `mvn test` in your terminal. \ No newline at end of file