Skip to content

Commit

Permalink
Merge pull request #5 from ProjectBIGWHALE/develop
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
erasmobezerra authored Nov 27, 2023
2 parents 1a6a034 + a31c827 commit 28a77d8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).


Expand Down

0 comments on commit 28a77d8

Please sign in to comment.