Skip to content

Commit 8252f05

Browse files
committed
Added OpenAPI definition for the REST API
1 parent 4cc26ca commit 8252f05

File tree

4 files changed

+150
-672
lines changed

4 files changed

+150
-672
lines changed

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
package.json
22
package-lock.json
3+
src/swagger.*

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ To verify that the application is working correctly, point your browser to
2727
[http://localhost:8080/api/books/design-patterns](http://localhost:8080/api/books/design-patterns) -
2828
you should see a response with one books in JSON format.
2929

30+
You can see a OpenAPI (Swagger) definition of the REST API at
31+
[http://localhost:8080/api-docs/](http://localhost:8080/api-docs/). This
32+
interface also allows you to interact with the API.
33+
3034
To debug the application in Chrome, point the browser to chrome://inspect and
3135
click on "Open dedicated DevTools for Node".
3236

0 commit comments

Comments
 (0)