feat(agora): create a spec-first REST API prototype in Java-Spring

[tschaffter]

Contributes to https://sagebionetworks.jira.com/browse/ARCH-309

Changelog

• Create the project agora-api-spring based on openchallenges-image-service
• Update the API to fetch the data version document from the MongoDB instance
• Update docker/agora to start the service with nx serve-detach agora-api-spring

Benefits

• Simplified overall Sage product architecture
  • Align Agora API architecture on OC architecture
• Increased reusability of components
  • Existing OC backend code is available to Agora
• Enhanced flexibility for engineering teams
• Improved developer experience
  • Generate most of the code with the OpenAPI generator
  • Developers can focus on implementing the features
  • OC microservices provide strong examples
  • Add Swagger UI
  • Add live reload
  • Add unit test framework
• Potential cost savings through resource optimization
  • Robust code generated by the OpenAPI Generator community

Preview

(Re)generate the API server after updating the Agora API description

nx run agora-api-spring:generate

Prepare the project

nx prepare agora-api-spring

Start the development server

nx serve agora-api-spring

Navigate to localhost:8086 to be redirected to the Swagger UI page.

Build the Docker image

nx build-image agora-api-spring

Serve the API with Docker

nx serve-detach agora-api-spring

Get the data version

With curl, using a command documented in Swagger UI:

$ curl -X 'GET' \
  'http://localhost:8086/v1/dataversion' \
  -H 'accept: application/json'
{"data_file":"syn13363290","data_version":"68","team_images_id":"syn12861877"}

In Swagger UI:

Swagger UI