Merge pull request #129 from nanotaboada/feature/readme-api-docs

chore: add API docs section

Author: nanotaboada

.vscode/launch.json

@@ -2,7 +2,7 @@
   "configurations": [
     {
       "type": "java",
-      "name": "Spring Boot (Debug)",
+      "name": "Java: Launch Spring Boot (Debug)",
       "request": "launch",
       "cwd": "${workspaceFolder}",
       "console": "internalConsole",

README.md

@@ -18,6 +18,14 @@ The following is a simplified dependency diagram of modules and main libraries:
 
 ![Dependency Diagram](java.samples.spring.boot.svg)
 
+## Documentation
+
+```console
+http://localhost:9000/swagger/index.html
+```
+
+![API Documentation](java.samples.spring.boot-swagger.png)
+
 ## Credits
 
 The solution has been coded using [Visual Studio Code](https://code.visualstudio.com/) with the [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)

java.samples.spring.boot-swagger.png

@@ -29,14 +29,14 @@
 import ar.com.nanotaboada.java.samples.spring.boot.services.BooksService;
 
 @RestController
-@Tag(name = "Books", description = "CRUD operations for books")
+@Tag(name = "Books")
 @OpenAPIDefinition(
     info = @Info(
         title = "java.samples.spring.boot",
         version = "1.0",
         description = "🧪 Proof of Concept for a RESTful Web Service made with JDK 21 (LTS) and Spring Boot 3",
         contact = @Contact(
-            name = "Github",
+            name = "GitHub",
             url = "https://github.com/nanotaboada/java.samples.spring.boot"
         ),
         license = @License(

src/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java

@@ -9,4 +9,7 @@ management.endpoint.health.show-details=always
 # http://localhost:9001/actuator/info
 management.info.env.enabled=true
 info.app.name=Sample RESTful Web Service with Spring Boot
-info.app.description=Proof of Concept for a RESTful Web Service made with Spring Boot 3 targeting JDK 21
+info.app.description=Proof of Concept for a RESTful Web Service made with Spring Boot 3 targeting JDK 21
+
+springdoc.api-docs.path=/docs
+springdoc.swagger-ui.path=/swagger/index.html