Swagger Documentation for REST API

44 views
Skip to first unread message

Peter Dietz

unread,
May 22, 2015, 11:36:43 AM5/22/15
to dspac...@googlegroups.com
Hi All,

I would like to provide richer documentation for the DSpace REST API, and the best example that I have seen is Swagger, annotating the REST API to generate documentation that shows all endpoints, the expected input, expected output (in various formats), as well as allowing a user to query a live instance. I've read the basics of Swagger, but my question now is, would we be able to markup our REST API, and contribute that to DSpace, or would annotating the REST API for Swagger somehow alter the REST API?
Reply all
Reply to author
Forward
0 new messages