[REQ/PROPOSAL/OFFER TO IMPLEMENT] - Native OpenAPI Overlay Support

Offen
#25,661 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
22/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
java, openapi
Bereich
api, build-system

Rechercherichtung

The payload names no source files. Start by reading how the generator loads and parses the input spec before code generation, since overlays must be applied at that point, and how the CLI, Gradle and Maven plugins pass the spec in. The author wants maintainers to agree on the integration approach (for example the overlay-jvm dependency) before any code is written, so check for a reply first. Done means one or more overlay files are applied before parsing, with tests across the CLI and build plugins.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Enhancement: Feature
Is your feature request related to a problem? Please describe.

Customizing OpenAPI specifications for code generation currently requires modifying the original spec, using generator-specific configuration options, or introducing external preprocessing steps.

This is particularly relevant when dealing with imperfect or non-compliant OpenAPI specifications that cannot be modified at their source.

Additionally, some generators already provide complex configuration options to inject vendor extensions without modifying the original specification. A standardized overlay mechanism could reduce the need to implement and maintain such generator-specific workarounds.

Describe the solution you'd like

Support the OpenAPI Overlay Specification natively, allowing one or more overlay files to be passed alongside the original specification.

Overlays should be applied before parsing and code generation, with support across CLI, Gradle, and Maven integrations.

This would enable users to:

  • Inject vendor extensions: Add x-implements, x-class-extra-annotation, or x-spring-paginated without modifying the source specification.
  • Customize schemas: Add missing properties, change property types, rename properties, or adjust required constraints.
  • Work around problematic specifications: Fix incorrect schema definitions, missing metadata, or other issues in externally maintained OpenAPI documents.
  • Customize operations: Add annotations, modify parameters, or exclude certain endpoints from generation.
  • Apply cross-cutting customizations: Use JSONPath expressions to apply common metadata or modifications across multiple schemas or operations.

It could also reduce the maintenance burden on OpenAPI Generator by providing a standardized alternative to generator-specific configuration options such as schemaImplements or typeInfoDefaultImpls, where equivalent vendor extensions already exist.

Describe alternatives you've considered

External preprocessing using tools such as Redocly CLI or custom build tasks.

Additional context

overlay-jvm could be a suitable implementation dependency because it:

  • Is written in Java and can integrate directly into the existing generator pipeline.
  • Provides a simple API for applying overlays to OpenAPI documents.
  • Supports JSON/YAML and standards-based JSONPath expressions.
  • Implements OpenAPI Overlay Specification 1.1.0.
  • Avoids introducing external tools or runtimes into the generation workflow.

Its focused scope could make integration relatively straightforward, although compatibility with newer Overlay Specification versions would need consideration.

I'd be willing to work on implementing this feature and submit a PR, provided the maintainers are open to the approach. Feedback on the proposed integration and preferred architecture would be appreciated before proceeding.

But of course sticking to custom pre-processing step also works. It just seems like such a natural fit, hence the proposal.

Vorherrschende Sprache
Java
Sterne
26.9k
Forks
7.8k
Ø Merge
2 T. 23 Min.
Gemergte PRs (30 T.)
177

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-generator

Alle Issues in OpenAPITools/openapi-generator

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.