OpenAPITools / OpenAPITools/openapi-generator

Community resource: Adoption guide for type-safe generic wrappers (Springdoc + Mustache)

Open
#22,075 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Hi all 👋

Sharing a community resource that may help teams using OpenAPI Generator with a generic response envelope (e.g., ServiceResponse<T>), while keeping clients type-safe and boilerplate-free:

Adoption guides (server/client):
🔗 blueprint-platform.github.io/openapi-generics
Reference repo (service + client + samples):
🔗 blueprint-platform/openapi-generics

Context: this approach tags wrapper schemas on the producer side (Springdoc) and lets the generator emit thin, type-safe shells (no duplicated fields) via a minimal template partial. It’s an opt-in pattern intended as a pragmatic bridge until broader $dynamicRef support is widely available across the toolchain.

If this is useful, I’m happy to contribute a short docs page or a sample under community resources. Feedback welcome!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked adoption guide and reference repository first, then inspect this repository's community-resource documentation structure. Confirm whether a short documentation page or sample is wanted and define its placement and acceptance criteria with maintainers; the issue names no target file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.