Add REST API spec docs

yorkie-team · Feb 5, 2024 · 2fc1e8a · 2fc1e8a
1 parent 0a6a12b
commit 2fc1e8a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/backend/README.md b/backend/README.md
@@ -24,6 +24,10 @@ This project is the backend part of the CodePair service developed using NestJS.
 
 4. Open [http://localhost:3000](http://localhost:3000) in your browser to access the backend.
 
+## API Specification
+
+You can access the Swagger-based REST API specification at `<API_URL>/api` when the backend server is running.
+
 ## Commands
 
 ### Building the Project: