# codefarm0/spring-ai architecture

> Architecture diagram of the GitHub repository codefarm0/spring-ai, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/codefarm0/spring-ai
- Repository: https://github.com/codefarm0/spring-ai

## Overview

##### Project type and purpose
- This is a Spring Boot–based backend microservice (“openai-demo-service”) whose goal is to demonstrate integration with the OpenAI API.
- It exposes REST endpoints (via OpenAIQnAController) that accept incoming questions or requests (e.g., “get capital”) and use prompt templates to drive calls to an external LLM service.

##### File structure
- Top level:
- README.md – high‐level description (“Spring AI Projects and tutorial”)
- docs/ – supplemental guides
- openai-demo-service/ – the Gradle‐based Spring Boot application
- openai-demo-service/src/main/java/com/codefarm/openai/demo/service/:
- OpenaiDemoServiceApplication.java – entry point
- OpenAIQnAController.java – HTTP layer (REST API)
- service/OpenAiService.java – business logic & external API integration
- model/… – domain data classes (Question, Answer, CapitalRequest/Response)
- openai-demo-service/src/main/resources/templates/*.st – StringTemplate prompt definitions
- openai-demo-service/src/test/java/… – comprehensive prompt‐driven test suite
- Configuration: application.properties holds API key and properties

##### README for additional insights
- The README simply positions this repo as a “Spring AI Projects and tutorial,” implying this is a learning/demo project rather than a production system.

##### Details
- Layer with the package or folder name (e.g., com.codefarm.openai.demo.service.service).

## Diagram (Mermaid)

```mermaid
flowchart TB
    Client["Client (cURL, Postman, UI)"]:::client

    subgraph "Spring Boot App (openai-demo-service)"
        direction TB
        Entry["OpenaiDemoServiceApplication"]:::internal
        Controller["OpenAIQnAController\n(REST API - Spring MVC)"]:::internal
        Service["OpenAiService\n(Business Logic & External API Integration)"]:::internal

        subgraph "Domain Model\n(com.codefarm.openai.demo.service.model)"
            direction TB
            Question["Question.java"]:::model
            Answer["Answer.java"]:::model
            CapitalRequest["CapitalRequest.java"]:::model
            CapitalResponse["CapitalResponse.java"]:::model
            CapitalResponseV2["CapitalResponseV2.java"]:::model
        end

        subgraph "Prompt Engine\n(StringTemplate Templates)"
            direction TB
            getCapital["get-capital-prompt.st"]:::template
            getCapitalInfo["get-capital-with-info-prompt.st"]:::template
            getCapitalJsonBinding["get-capital-with-json-binding-prompt.st"]:::template
            getCapitalJson["get-capital-with-json-prompt.st"]:::template
        end

        Config["application.properties\n(API Key & Properties)"]:::config

        subgraph "Test Suite"
            direction TB
            TestApp["OpenaiDemoServiceApplicationTests.java"]:::tests
            TestService["OpenAiServiceTest.java"]:::tests
            PromptTests["*Prompting Tests (all *Tests.java)"]:::tests
        end
    end

    External["OpenAI GPT-4 API\n(External LLM Service)"]:::external
    Docs["README.md & docs/"]:::docs

    Client -->|"POST /ask\nJSON payload"| Controller
    Entry --> Controller
    Controller -->|"delegate call"| Service
    Service -->|"loads templates"| getCapital
    Service --> getCapitalInfo
    Service --> getCapitalJsonBinding
    Service --> getCapitalJson
    Service -->|"HTTPS request with prompt & API Key"| External
    External -->|"JSON response"| Service
    Service -->|"map to domain model"| Controller
    Controller -->|"200 OK JSON response"| Client
    Entry --> Config
    Docs -.-> Client

    click Controller "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/OpenAIQnAController.java"
    click Service "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/service/OpenAiService.java"
    click getCapital "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/resources/templates/get-capital-prompt.st"
    click getCapitalInfo "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/resources/templates/get-capital-with-info-prompt.st"
    click getCapitalJsonBinding "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/resources/templates/get-capital-with-json-binding-prompt.st"
    click getCapitalJson "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/resources/templates/get-capital-with-json-prompt.st"
    click Question "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/model/Question.java"
    click Answer "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/model/Answer.java"
    click CapitalRequest "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/model/CapitalRequest.java"
    click CapitalResponse "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/model/CapitalResponse.java"
    click CapitalResponseV2 "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/model/CapitalResponseV2.java"
    click Entry "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/java/com/codefarm/openai/demo/service/OpenaiDemoServiceApplication.java"
    click Config "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/main/resources/application.properties"
    click TestApp "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/test/java/com/codefarm/openai/demo/service/OpenaiDemoServiceApplicationTests.java"
    click TestService "https://github.com/codefarm0/spring-ai/blob/main/openai-demo-service/src/test/java/com/codefarm/openai/demo/service/service/OpenAiServiceTest.java"
    click PromptTests "https://github.com/codefarm0/spring-ai/tree/main/openai-demo-service/src/test/java/com/codefarm/openai/demo/service/prompting/"

    classDef client fill:#D3D3D3,stroke:#000,color:#000
    classDef internal fill:#a0c4ff,stroke:#000,color:#000
    classDef model fill:#bdb2ff,stroke:#000,color:#000
    classDef template fill:#ffadad,stroke:#000,color:#000
    classDef config fill:#ffd6a5,stroke:#000,color:#000
    classDef external fill:#caffbf,stroke:#000,color:#000
    classDef docs fill:#fffffc,stroke:#000,color:#000
    classDef tests fill:#d0f4de,stroke:#000,color:#000
```
