From a31c82763ef9b95c26022da6f14cc49740b6f4ad Mon Sep 17 00:00:00 2001 From: Erasmo Bezerra Date: Mon, 27 Nov 2023 12:17:43 -0300 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62894cd..db9e59a 100755 --- a/README.md +++ b/README.md @@ -58,7 +58,11 @@ java -jar target/whale-api.jar ``` ## 📚 API Documentation -The API documentation, automatically generated by Spring, will be available at: +![image](https://github.com/ProjectBIGWHALE/bigwhale-api/assets/57486221/194576ad-d432-4c23-a9c6-b9ca5e29b71a) + +There are tools that easily allow you to build interaction interfaces with your API, in order to test functionalities quickly and without the need to create code. We then chose to use Swagger. + +After performing the steps in the Confgurations section, access our API's interactive documentation at: - [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html).