ofbiz-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nicolas Malin (Jira)" <j...@apache.org>
Subject [jira] [Commented] (OFBIZ-11007) REST: adding segmented URI support
Date Fri, 03 Jan 2020 14:44:01 GMT

    [ https://issues.apache.org/jira/browse/OFBIZ-11007?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17007528#comment-17007528

Nicolas Malin commented on OFBIZ-11007:

Hello [~mthl],

Sure follows best practice given by the JAX-RS is better.

After a second analyze and crossed different vision with [~mleila] I propose to change nothing
and keep your first approach on uri resolution.

We can use this pattern :
entity/[cover]/{entityName}/{pkValues: .*}{code}
Example :
    entity/find/Party -> search
    entity/find/Party/Company -> displaying form
    entity/create/Party -> creation form
    entity/edit/Party/Company -> edit form
    entity/change/Party/Company -> call crud 
    entity/relations/Party {code}
I updated the patch [^OFBIZ-11007_refactor-entitymaint.patch] with this logic

> REST: adding segmented URI support
> ----------------------------------
>                 Key: OFBIZ-11007
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-11007
>             Project: OFBiz
>          Issue Type: New Feature
>          Components: framework
>    Affects Versions: Trunk
>         Environment: 
>            Reporter: Artemiy Rozovyk
>            Assignee: Nicolas Malin
>            Priority: Minor
>              Labels: REST, URI
>             Fix For: Upcoming Branch
>         Attachments: OFBIZ-11007_refactor-entitymaint.patch, OFBIZ-11007_refactor-entitymaint.patch,
OFBIZ-11007_refactor-entitymaint.patch, entitymaint_example.patch, restful_URIs.patch
> Following the discussion on making OFBiz RESTful OFBIZ-4274 i implemented the support
of segmented URIs without interfering with current mechanisms of URI resolution nor with 
_overrideView()_ feature.
> Combined with work on associating URIs and HTTP methods done by [~mthl] in OFBIZ-10438
, we are now able to provide RESTful APIs as follows:
> {code:java}
> <request-map uri="foo/bar" method="get">
> ...
> <request-map uri="foo/bar/{baz}" method="get">
> ...
> <request-map uri="foo/bar/{baz}" method="post">
> ...
> {code}
> After we matched a request-map having parametrized URI as in 
> {code:java}
> uri="foo/bar/{baz}"
> {code}
> the value is available inside the request attributes with the corresponding key (here
> The *restful_URIs.patch* allows segmented URI support.
> The *entitymaint_example.patch* is a modified _entitymaint_ part that serves as an example
of possible application of new system. 
> Any questions or comments are welcomed.

This message was sent by Atlassian Jira

View raw message