Update and configure SpringDoc Open API and Swagger

[timler]

Set up SpringDoc to enable Swagger UI for local API exploration and testing.

About the changes:

This allows:

• Interactive API testing via Swagger UI at /swagger-ui.html
• OpenAPI spec download in JSON (/api-docs) or YAML (/api-docs.yaml) format which will be used to generate API documentation.

Added OpenAPI annotations to JwtAuthenticationRestController to support authentication through the Swagger UI, which is needed to use the other endpoints.

Added documentation to the endpoints to specify

• Name tags for each controller
• Descriptions for all the endpoints
• Definitions for all the parameters, the request body, and the return status codes and response body

Both the API docs and Swagger UI can be disabled via application properties:

springdoc.api-docs.enabled=false
springdoc.swagger-ui.enabled=false

Usage

Access the Swagger UI at:

• http://localhost:8084/swagger-ui/index.html

Access the OpenAPI spec at:

• http://localhost:8084/v3/api-docs (JSON)
• http://localhost:8084/v3api-docs.yaml

Authenticate

To use the API, you need to authenticate. To do so, follow these steps:

To get an access token:

1. Scroll to jwt-authentication-rest-controller
2. Open the Post /authenticate endpoint
3. Click "Try it out"
4. Enter your login details
5. Click "Execute"

To use the token to authenticate your requests:

6. Scroll to the top, click "Authorize" button
7. Enter token
8. Click "Authorise"

Now you can use the Swagger API endpoints