Skip to content

Commit c6c2343

Browse files
committed
Added instructions on how to access the Swagger API documentation
1 parent 9281c48 commit c6c2343

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
API backend for [Programming Buddies](https://github.com/ProgrammingBuddies/programmingbuddies-ui) (projects management)
44

5+
## API documentation
6+
The documentation is dynamically generated by the server using [Swagger](https://swagger.io) and [Swagger UI](https://swagger.io/tools/swagger-ui/)
7+
- To view the documentation run the server using one of the set up guides below and then head to `/docs` endpoint
8+
- e.g. https://localhost:5001/docs for local development
9+
510
## Set up guide: The simple way
611

712
- Set up your [environment](#environment)

0 commit comments

Comments
 (0)