[
https://issues.apache.org/jira/browse/SYNCOPE-151?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13802811#comment-13802811
]
Francesco Chicchiriccò commented on SYNCOPE-151:
------------------------------------------------
Just [committed|http://svn.apache.org/r1534986] an initial version with a
servlet taking care of transforming, via Cocoon 3, the WADL generated by CXF
into a couple of HTML files (one for REST resources, one for Schema browsing).
This servlet is now available at http://host:port/syncope/rest/docs/
Currently, only UserService was documented since there is a chance that
CXF-5353 will let us avoid duplicating Javadocs content into @Description
annotations.
Moreover, the [release process
page|http://syncope.apache.org/release-process.html] needs to be updated with
steps for adding RESTful API documentation to website.
> Document RESTful services
> -------------------------
>
> Key: SYNCOPE-151
> URL: https://issues.apache.org/jira/browse/SYNCOPE-151
> Project: Syncope
> Issue Type: Improvement
> Components: core, documentation
> Reporter: Francesco Chicchiriccò
> Assignee: Francesco Chicchiriccò
> Labels: rest
> Fix For: 1.2.0
>
>
> Provide dynamic documentation for RESTful services: the easiest and most
> effective way seems to be via XSLT processing of WADL information,
> auto-generated by CXF (see [1] for more information).
> Relevant discussion on dev ML: [2].
> [1]
> http://cxf.apache.org/docs/jaxrs-services-description.html#JAXRSServicesDescription-WADLAutoGeneration
> [2]
> http://syncope-dev.1063484.n5.nabble.com/DISCUSS-Document-RESTful-APIs-td5714317.html
--
This message was sent by Atlassian JIRA
(v6.1#6144)
