We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 9281c48 commit c6c2343Copy full SHA for c6c2343
README.md
@@ -2,6 +2,11 @@
2
3
API backend for [Programming Buddies](https://github.com/ProgrammingBuddies/programmingbuddies-ui) (projects management)
4
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
+
10
## Set up guide: The simple way
11
12
- Set up your [environment](#environment)
0 commit comments