Rest Services in EasySOA

[tiry]

Inside Nuxeo Platform, in terms of Web Service we are mainly focussed on http / rest based WebService and don't really use SOAP or SCA. The "approach" is documented here.

Because of that we are very interested in integrating inside EasySOA support for Rest based Web Service :

• this would allow to use EasySOA for Nuxeo WebServices too
• this would enable the EsaySOA by EasySOA approach (since some of the features are exposed via Nuxeo)

In order to make this a really, we must discuss about changes in EasySOA current implementation, but also in Nuxeo services implementation (mainly Nuxeo Content Automation).

Here is a list of the points related to this specific topic.

add support for GET requests on Automation

EasySOA-registry remote API is mainly a wrapper around the Automation API.

The main reason for this wrapping seens to be to expose GET api whereas Automation is by default POST oriented.

Rather that doing a wrapper in EasySOA, I can easily add a handler for GET requests in Automation Server.

This would make sense for EasySOA, but clearly this also makes sense for Nuxeo.

=> Interested ?

Support for Automation Services in EasySOA

EasySOA currently supports WSDL and SCA based services definition.

Nuxeo Automation services are not based on any of this solution : services are exposed and autodocumented via JSON, you can have a quick overview by looking at Explorer

For now I basically see 3 approches :

• integrate Automation JSON definition in EasySOA

  (this would be very custom and not really interesting for EasySOA I guess)

• make a SOAP binding on Automation

  (this makes sense and would be useful but it seems to be a pitty for force Rest Services to be SOAP compliant ....)

• define a REST definition model (may be based on SPORE) and align Nuxeo on it

=> WDYT ?

Automation Sandbox

I want to extend automation documentation view so that we can leverage the recently added JS api to directly call the services from the HTML page.

This will of course be limited by SOP, but this will allow "end users" to quickly experiment the service API.

The idea is to have something like the Google OAuth Playground : a web page were a end user can easily experiment the WebServices without needed real technical knowledge.

Inside Nuxeo, we have recently added some features that could be used as a base for this.

=> Does it make sense at least in the context of EasySOA light ?

=> Does that sound like something interesting for EasySOA ?

[mdutoo]

I'm full for REST support, "easysoa by easysoa" and things benefiting to both Nuxeo and EasySOA.

So very good ideas, if we manage to unify EasySOA services, EasySOA-known services and Nuxeo Content Automation services :

• EasySOA services : for now JAXRS / WebEngine, provides remote API (Discovery) and WSDL scraping.
• EasySOA-known services : for now only supports SOAP and WSDL definitions. For supporting REST, it depends the use cases we want to support, and how (FraSCAti might help directly or to make benefits available outside Nuxeo). A few ideas :
  • JAXRS interfaces as definition, to be friendly with Java and especially FraSCAti
  • WADL for other static languages
  • SPoRE specs for making it easier for clients built on scripting languages
  • a testing client that takes advantage of REST's browsability (and see how it could help on the SOAP side with some correlations on the WSDL - or would it be rather an "interactive RESTifier for SOAP" we're talking about ?)
  • Nuxeo json definition for Nuxeo developers
  • Swagger spec (extended JAXRS and / or json spec) to make first-class citizens out of API servers built on the Swagger platform, which may bring its own online API documentation and testing as well as platform features
• Nuxeo Content Automation services : allows for auto & manual doc, as said possibly testing