Imported from land-of-apps/java-microservice-demo (AGENTS.md). Install upstream with npx skills add land-of-apps/java-microservice-demo. Copyright stays with the author.

Agent Development Notes for microservice-demo

This project is a Java Maven multi-module project consisting of two cooperating Spring Boot microservices.

Project Structure

• Root Directory: microservice-demo/
  • Contains the parent pom.xml and modules for service-a and service-b.
• service-a: Located at microservice-demo/service-a/
  • Spring Boot application.
  • Listens on port 8080.
  • Calls service-b at http://localhost:8081.
• service-b: Located at microservice-demo/service-b/
  • Spring Boot application.
  • Listens on port 8081.
  • Returns a simple "Hello from Service B" message.

Technologies

• Language: Java 17
• Build Tool: Maven
• Framework: Spring Boot 2.6.3

Key Files

• microservice-demo/pom.xml: Parent POM, defines modules and dependency management.
• microservice-demo/service-a/pom.xml: Service A POM, includes spring-boot-starter-web.
• microservice-demo/service-b/pom.xml: Service B POM, includes spring-boot-starter-web.
• microservice-demo/service-a/src/main/java/com/example/servicea/ServiceAApplication.java: Main application class for Service A.
• microservice-demo/service-b/src/main/java/com/example/serviceb/ServiceBApplication.java: Main application class for Service B.
• microservice-demo/service-a/src/main/resources/application.properties: Service A configuration (port 8080).
• microservice-demo/service-b/src/main/resources/application.properties: Service B configuration (port 8081).

Development Workflow

1. Build: Run mvn clean install from the microservice-demo/ root directory.
2. Run Services:
   • Start Service B: java -jar microservice-demo/service-b/target/service-b-1.0-SNAPSHOT.jar
   • Start Service A: java -jar microservice-demo/service-a/target/service-a-1.0-SNAPSHOT.jar
   • Both services need to be running concurrently for service-a to successfully call service-b.
3. Test: Once both services are running, test service-a using curl http://localhost:8080. This will trigger the call to service-b.

Important Considerations

• When modifying code, ensure changes adhere to Spring Boot conventions.
• When adding new features or dependencies, update the respective pom.xml files.
• Be mindful of port conflicts if running other services.
• The RestTemplate in ServiceAApplication uses http://localhost:8081, so service-b must be accessible at that address.
• Be sure to keep the documentation (including this file) up to date.