Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

SchemaRepository Injection into OpenAPIContract

Abierto
  • ¿Algo no está bien?
#93 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
java, openapi
Área
api, backend-api-design

Línea de trabajo

Empieza leyendo el flujo de OpenAPIContract::from y SchemaRepository dereference(), y compáralo después con la funcionalidad relacionada de vertx-json-schema mencionada en el issue. Se considera completado cuando la hidratación y la validación de esquemas se puedan reutilizar, y se pueda proporcionar un SchemaRepository hidratado previamente a OpenAPIContract::from para varios contratos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
Describe the feature

This stems from a concern that the provided interfaces prevent reuse of what should be immutable objects in memory. For context, to load up a SchemaRepository's lookup table, we need to read in our schema files and then run them through a dereference(). The OpenAPIContract class does that alongside some validation in its from() function, which is really nice.

To explain the problem, now suppose that I have multiple open api files and thus need multiple OpenAPIContracts that produce routers that are eventually attached as subrouters for the rest server. Each OpenAPIContract will have its own SchemaRepository. Also consider that someone may want a fully hydrated SchemaRepository that I want to expose to a swagger ui or arbitrary http clients (I did that with a handler on some schema route that does the lookup/resolve for the schema and returns it). Every single OpenAPIContract and the separate SchemaRepository for exposing to clients will have duplicate/immutable schemas in memory.

The feature would be to genericize the validation/repo filling (which is filled by calling dereference() on the repo) logic in OpenAPIContract::from, probably moved into the vertx-json-schema library. Then allow a SchemaRepository to be provided to OpenAPIContract::from. That would allow the hydration of a SchemaRepository and then for it to be reused everywhere it is needed.

Use cases

The big use case is the reuse of SchemaRepository's for OpenAPIContracts and also the generalization of a very useful hydration feature for loading schemas into a SchemaRepository. OpenAPIContract is not the only class that can make use of that validation/repo filling logic. The only useful logic I've seen for filling a SchemaRepository's internal lookup map is in OpenAPIContract, but that's not something that should be specific to the openapi library.

Code reuse and saving on memory usage and startup time are the real benefits. In my eyes I would say that this is necessary polish.

Contribution

Who should implement this feature ? are you volunteering for implementing this feature or
do you know that is able and willing implement this feature ?

Lenguaje dominante
Java
Estrellas
15
Forks
19
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de eclipse-vertx/vertx-openapi

Todos los issues de eclipse-vertx/vertx-openapi

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.