In my initial go at swagger I may of been distracted by how nice it was to
describe the end points and parameters; and ignored sheer amount of work
required to document our XML output. It is basically reproducing an
XMLSchema worth of information for the different end points. Helpful for
JSON, but perhaps not suitable for our XStream based stores
representation. I hope we can find a cheerful middle ground.
--
Jody Garnett
On 3 February 2017 at 08:55, Matt Kruszewski <mkruszew...@boundlessgeo.com>
wrote:
> Hi Mike,
>
> Given the upcoming switch to Spring MVC for the REST API, I wanted to
> start a conversation about possible improvements for the REST documentation
> (GEOS-7931). One option is Swagger, which has a lot of supporting tooling
> and is able to automatically generate docs from Spring MVC annotations --
> though some additional annotations might be required to flesh things out.
> What experience does everyone have with REST documentation formats and
> tools?
>
> Jody and I are doing some initial research and prototyping, and we have
> gathered our notes so far on the wiki (https://github.com/geoserver/
> geoserver/wiki/REST-API-Refresh).
>
> Thanks,
> Matt Kruszewski
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, SlashDot.org! http://sdm.link/slashdot
> _______________________________________________
> Geoserver-devel mailing list
> Geoserver-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/geoserver-devel
>
>
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
