Oh that be great!! top of my mind, the way we tackle this at work is
to specify an openapi.yaml file, and we derive the implementation from
that. Having the spec first has yield us a lot of benefits, but if you
feel like jumping directly on to the JAX-RS side, it'd be fine for me
too.

As per the API itself, I guess at least it should contain something
like login, logout and f.ex., crud for pages (crud for attachments,
admin, etc. could arrive later on). Everything except login should be
able to accept some kind of session/login id, be it a header or
whatever. Ideally, the code from the main jsp files should be
extracted so it can be reused on the REST api, so that both behave
equal and fixes can be done on only one place, but I don't know if
that's feasible.

If I'd be tackling that, all above would mean at least 3 new modules:
one for the openapi spec, another for the JAX-RS implementation and
the third one with the code extracted from the JSP files. But that
would me, approaching it, without having thought on it more than this
e-mail, so if you come with something different, it'd probably be fine
too.

WDYT?

cheers,
juan pablo

On Sat, May 10, 2025 at 4:48 AM Murray Altheim <murra...@altheim.com> wrote:
>
> Hi Juan Pablo,
>
> I know I haven't been very active for a long time in terms of contributing
> code (lots has happened at this end), but if I had a basic specification
> of what was expected I could probably build out a RESTful API for JSPWiki
> reasonably quickly (depending on whether or not there are any gotchas in
> the specification), and would be interested in doing so as it'd integrate
> that into a large software project I've been working on for years. I'd
> definitely use JAX-RS so that we could keep the implementation entirely
> within Java itself.
>
> But yes, I agree, having a RESTful API would obviate the need for XML-RPC.
>
> Cheers,
>
> Murray
>
> On 10/05/25 06:24, Juan Pablo Santos Rodríguez wrote:
> > ouch I missed your email between all GH threads. I've also haven't
> > seen xmlrpc usage of JSPWiki, but prefer to keep it there to see if we
> > can keep it on 3.0.0 somehow, as we haven't any easy direct
> > replacement. Perhaps a proper replacement would be to have a web API /
> > some kind of JAX-RS, ideally derived from an openapi.yaml file.
> >
> > Also, if we finally ditch the xmlrpc support, it'd be matter of simply
> > removing the module, the work of locating the affected code would be
> > already done.
> >
> > cheers,
> > juan pablo
>
> ...........................................................................
> Murray Altheim <murray18 at altheim dot com>                       = =  ===
> http://www.altheim.com/murray/                                     ===  ===
>                                                                     = =  ===
>      In the evening
>      The rice leaves in the garden
>      Rustle in the autumn wind
>      That blows through my reed hut.
>             -- Minamoto no Tsunenobu
>

Reply via email to