Add initial README with architecture, features, setup, and testing de…

[mattknatt]

…tails; update WireMock dependency in pom.xml for test improvements

Summary by CodeRabbit

• Documentation

  • Added comprehensive project documentation including architecture overview, configuration guide, API contract details, and deployment instructions for the Spring LLM Gateway application.

• Chores

  • Updated testing framework dependencies to improve test infrastructure.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a7e4a07b-4e28-4eb7-bff1-c2194d962ef1

📥 Commits

Reviewing files that changed from the base of the PR and between 50b49d7 and 254fae3.

📒 Files selected for processing (2)

• README.md
• pom.xml

---

📝 Walkthrough

Walkthrough

This PR adds comprehensive README documentation for the Spring LLM Gateway project, covering architecture, configuration, API contracts, features, testing, and project structure. It also upgrades the WireMock test dependency from the standalone version 3.13.2 to the Spring Boot integration version 4.0.9.

Changes

Documentation and Dependency Configuration

Layer / File(s)	Summary
Overview and Architecture README.md	Introduces project title, purpose, and high-level architecture describing controller/service/client flow with personality-based prompts, conversation history, and retry logic.
Setup and Configuration README.md	Prerequisites, required environment variables, mapping to application.properties, build/run instructions, default port, and Swagger UI URL documented.
API Reference README.md	POST /api/v1/chat endpoint fully documented with request/response field descriptions and example payloads for success and error cases.
Features and Behavior README.md	Personality keys mapped to system prompts; conversation memory semantics (history limits, expiry, sessionId); exception-to-HTTP-status mappings and retry policy parameters.
Testing and Project Structure README.md	Test command and breakdown of test classes with validation coverage; directory tree for src/main/java and src/test/java packages.
Dependency Configuration pom.xml	WireMock test dependency upgraded from org.wiremock:wiremock-standalone:3.13.2 to org.wiremock.integrations:wiremock-spring-boot:4.0.9.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• mattknatt/spring-llm-gateway#2: Both PRs modify the WireMock test dependency in pom.xml; this PR upgrades it to wiremock-spring-boot 4.0.9.

Poem

📚✨ A rabbit hopped through the code today,
With README fresh and bright to display,
Dependencies upgraded, WireMock now springs,
Documentation of features and things!
The gateway is ready, clear as can be—
A visitor's map for all eyes to see! 🐰

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch readme

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}