Merge branch 'main' of github.com:vesalukkarila/songs-api

vesalukkarila · Oct 23, 2024 · 93ff22a · 93ff22a
2 parents 7581eab + 3d94678
commit 93ff22a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,10 @@ To run the application, you have two choices:
     ```
 3. Open the api in http://localhost:8080
 
+## Documentation
+Since this project is developed in plain Spring (which doesn't natively support Swagger), the OpenAPI specification has been manually written to describe the API endpoints, request bodies, responses, and error handling. Documentation is hosted at github pages:
+https://vesalukkarila.github.io/songs-api/
+
 ## Endpoints
 
 <details>