#2 README api documentation section

skoro · Aug 27, 2024 · 993b2ee · 993b2ee
1 parent e04fead
commit 993b2ee
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,3 +36,9 @@ _TBD: make docker installation_
     symfony serve -d
     ```
 
+## API documentation
+ Two end-points are available for getting the API documentation:
+ - `/api/doc` swagger ui. 
+ - `/api/doc.json`
+    as above but in Json format
+    for consuming by [Postman](https://www.postman.com/product/what-is-postman/), for example.