Jason Gerlowski created SOLR-16347:
--------------------------------------
Summary: Add JAX-RS integration for defining v2 APIs
Key: SOLR-16347
URL: https://issues.apache.org/jira/browse/SOLR-16347
Project: Solr
Issue Type: Improvement
Security Level: Public (Default Security Level. Issues are Public)
Components: v2 API
Affects Versions: main (10.0)
Reporter: Jason Gerlowski
SOLR-15182 rewrote our v2 APIs to use annotations using an existing (in-house)
framework. But continuing to use a homegrown framework is less than ideal for
a few reasons:
# Our in-house framework doesn't integrate with 3rd-party tooling like OpenAPI.
# It gives us less functionality than many off-the-shelf frameworks, at a
higher maintenance cost.
# The current framework is less explicit about API inputs and outputs than many
off-the-shelf alternatives, making code less clear and readable for developers.
(For more on the pros/cons and for different evaluations on the tradeoff here,
see [this|https://lists.apache.org/thread/6wx2vzfnmfgkw03b7s450zfp7yhrlz8f]
long-running dev@ thread.)
The work done by SOLR-15182 makes the jump to JAX-RS reasonably straightforward
on an individual API basis: once the framework is in place switching a given
API to JAX-RS is mostly a matter of swapping out our homegrown annotations for
those recognized by JAX-RS and changing API method signatures to better
represent the API inputs/outputs.
We should integrate Jersey or a similar JAX-RS implementation and start cutting
over v2 APIs to this new mode of definition.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
