Skip to content

Commit 0720c16

Browse files
committed
docs(architecture): add rationale and improve project documentation
1 parent f0f3605 commit 0720c16

3 files changed

Lines changed: 255 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,12 +556,27 @@ The provided parent configuration includes a tested default, but consumers may o
556556

557557
## References
558558

559+
### Project Documentation
560+
561+
- **Rationale**
562+
[Why OpenAPI Generics Exists](./docs/architecture/rationale.md) — Explains the architectural motivation, engineering trade-offs, and ecosystem constraints behind the project.
563+
559564
- **Adoption Guide (GitHub Pages)**
560565
[Spring Boot OpenAPI Generics — Adoption Guide](https://blueprint-platform.github.io/openapi-generics/)
561566

567+
### Articles
568+
562569
- **Medium Article**
563570
[We Made OpenAPI Generator Think in Generics](https://medium.com/@baris.sayli/type-safe-generic-api-responses-with-spring-boot-3-4-openapi-generator-and-custom-templates-ccd93405fb04)
564571

572+
### Standards & Specifications
573+
574+
- **OpenAPI Specification 3.2.0**
575+
https://spec.openapis.org/oas/v3.2.0.html
576+
577+
- **JSON Schema Draft 2020-12**
578+
https://json-schema.org/draft/2020-12
579+
565580
- **RFC 9457**
566581
[Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457)
567582

docs/architecture/architecture.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,13 @@ Supported capabilities:
161161

162162
## Module Map
163163

164-
| Module | Responsibility |
165-
|----------|----------------|
166-
| [`openapi-generics-contract`](../../README.md) | Shared contracts and platform types |
167-
| [`openapi-generics-server-starter`](../../openapi-generics-server-starter/README.md) | Spring Boot projection pipeline |
168-
| [`openapi-generics-java-codegen`](../../openapi-generics-java-codegen/README.md) | Contract-aware OpenAPI Generator extension |
164+
| Module | Responsibility |
165+
|------------------------------------------------------------------------------------------------|----------------|
166+
| [`openapi-generics-contract`](../../openapi-generics-contract/README.md) | Shared contracts and platform types |
167+
| [`openapi-generics-server-starter`](../../openapi-generics-server-starter/README.md) | Spring Boot projection pipeline |
168+
| [`openapi-generics-java-codegen`](../../openapi-generics-java-codegen/README.md) | Contract-aware OpenAPI Generator extension |
169169
| [`openapi-generics-java-codegen-parent`](../../openapi-generics-java-codegen-parent/README.md) | Generator orchestration and template lifecycle |
170-
| [`openapi-generics-platform-bom`](../../openapi-generics-platform-bom/README.md) | Dependency alignment |
170+
| [`openapi-generics-platform-bom`](../../openapi-generics-platform-bom/README.md) | Dependency alignment |
171171

172172
---
173173

0 commit comments

Comments
 (0)