Add OpenAPI UI and JSON description of the API

README.md

@@ -14,7 +14,7 @@ mvn spring-boot:start
 mvn spring-boot:stop
 ```
 
-Observability root path: http://localhost:8080/actuator.
+# Docker dependency services
 
 Clean local Docker environments:
 
@@ -31,13 +31,18 @@ docker compose up
 docker compose up --force-recreate --renew-anon-volumes
 ```
 
+See [docker-compose.yml](./docker-compose.yml) for all services.
+
+# Observability
+
+We use Spring Boot actuator to gather several metrics. It is exposed here: http://localhost:8080/actuator.
+
 Now on your machine different services are available:
 
+- Swagger UI: http://localhost:3001
 - Grafana: http://localhost:3000
 - Prometheus: http://localhost:9090
 
-See [docker-compose.yml](./docker-compose.yml) for all services.
-
 Grafana dashboards:
 - https://grafana.com/grafana/dashboards/6756-spring-boot-statistics/
 - Ideally there would be a standard dashboard for endpoints and another for database connections.

docker-compose.yml

@@ -23,3 +23,10 @@ services:
       - ./src/main/resources/static/monitoring/dashboard.json:/etc/dashboards/spring-boot-grafana-dashboard.json:rw
     ports:
       - 3000:3000
+
+  swagger-ui:
+    image: swaggerapi/swagger-ui:latest
+    ports:
+      - "3001:8080"
+    environment:
+      URL: http://localhost:8080/api-docs

pom.xml

@@ -52,6 +52,11 @@
 			<artifactId>spring-boot-devtools</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
+			<version>2.2.0</version>
+		</dependency>
 	</dependencies>
 
 	<build>

src/main/resources/application.properties

@@ -1 +1,2 @@
-management.endpoints.web.exposure.include=*
+management.endpoints.web.exposure.include=*
+springdoc.api-docs.path=/api-docs