stratos-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Isuru Haththotuwa <isu...@apache.org>
Subject Re: Consistent Response structure for Stratos REST APIs
Date Tue, 08 Jul 2014 07:29:23 GMT
+1 for this change. We can use a standard way to do this, such as returning
a 'Response' type [1].

[1].  http://docs.oracle.com/javaee/6/api/javax/ws/rs/core/Response.html


On Tue, Jul 8, 2014 at 10:10 AM, Dakshika Jayathilaka <dakshika@wso2.com>
wrote:

> +1 for having proper back end error mechanism for end users, but when we
> are designing it has to adhere some proper standard, coz this is community
> project and many contributors may take part on this.  If we loosed the
> concepts on starting point that will deviate whole concept of having
> standardization.
>
> WDYT?
>
> *Dakshika Jayathilaka*
> Software Engineer
> WSO2, Inc.
> lean.enterprise.middleware
> 0771100911
>
>
> On Mon, Jul 7, 2014 at 2:46 PM, Udara Liyanage <udara@wso2.com> wrote:
>
>> Hi Dakshita,
>>
>> I am really worried about the structure of the response rather than what
>> values it should output. What I wanted to tell is every API call should
>> send response adhering to that format regardless of the fields it has.
>>
>> For a REST client for Stratos, http status code is important in very few
>> occasions, rather client is more interested in the back end error message.
>>
>>
>> On Mon, Jul 7, 2014 at 5:37 PM, Dakshika Jayathilaka <dakshika@wso2.com>
>> wrote:
>>
>>> There are some instances we need to have HTTP status + attribute details
>>> on body.
>>>
>>> ex:
>>>
>>> *409 conflict: *can return in different scenarios, so we need to
>>> implement some differentiation mechanism
>>>
>>> if you check HTTP/1.1[1] spec its clearly mention this:
>>>
>>> The response body SHOULD include enough information for the user to
>>> recognize the source of the conflict.
>>>
>>> [1] http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
>>>
>>>
>>>
>>> *Dakshika Jayathilaka*
>>> Software Engineer
>>> WSO2, Inc.
>>> lean.enterprise.middleware
>>> 0771100911
>>>
>>>
>>> On Mon, Jul 7, 2014 at 10:54 AM, Imesh Gunaratne <imesh@apache.org>
>>> wrote:
>>>
>>>> Udara, there are few other important points:
>>>>  * Introduce versioning to the API and preserve v1.0 released with
>>>> Stratos 4.0.0 for a certain time period.
>>>>  * introduce token based  authentication.
>>>>
>>>> May be we could do these with  separate tasks.
>>>>
>>>> Thanks
>>>>
>>>>
>>>> On Monday, July 7, 2014, Imesh Gunaratne <imesh@apache.org> wrote:
>>>>
>>>>> +1 Definitely, we need to do this. Jsend spec looks good, but I wonder
>>>>> whether we need a status attribute since HTTP status code already does
that.
>>>>>
>>>>> One other important fact is that we need to  document the API
>>>>> definition very well with samples.
>>>>>
>>>>> Thanks
>>>>>
>>>>> On Monday, July 7, 2014, Udara Liyanage <udara@wso2.com> wrote:
>>>>>
>>>>>> HI,
>>>>>>
>>>>>> Currently different REST API methods sends response in different
>>>>>> formats. Some API methods have Response as the return type and some
have
>>>>>> Response. IMO it is better if all the API methods fallow the same
format.
>>>>>> For instance [1] discuss a simple response format.
>>>>>>
>>>>>> [1] http://labs.omniti.com/labs/jsend
>>>>>>
>>>>>> --
>>>>>>
>>>>>> Udara Liyanage
>>>>>> Software Engineer
>>>>>> WSO2, Inc.: http://wso2.com
>>>>>> lean. enterprise. middleware
>>>>>>
>>>>>> web: http://udaraliyanage.wordpress.com
>>>>>> phone: +94 71 443 6897
>>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Imesh Gunaratne
>>>>>
>>>>> Technical Lead, WSO2
>>>>> Committer & PPMC Member, Apache Stratos
>>>>>
>>>>>
>>>>
>>>> --
>>>> Imesh Gunaratne
>>>>
>>>> Technical Lead, WSO2
>>>> Committer & PPMC Member, Apache Stratos
>>>>
>>>>
>>>
>>
>>
>> --
>>
>> Udara Liyanage
>> Software Engineer
>> WSO2, Inc.: http://wso2.com
>> lean. enterprise. middleware
>>
>> web: http://udaraliyanage.wordpress.com
>> phone: +94 71 443 6897
>>
>> --
>> Thanks and Regards,
>>
>> Isuru H.
>> +94 716 358 048* <http://wso2.com/>*
>>
>>
>> * <http://wso2.com/>*
>>
>>
>>

Mime
View raw message