Re: OFBiz REST implementation session #2 (10/07/2020)

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
grv
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz REST implementation session #2 (10/07/2020)

grv
Hi All

Please note the meeting details for tomorrow's session -

Topic: REST Session #2
Time: Oct 7, 2020 04:00 PM Mumbai, Kolkata, New Delhi, 12:30 PM CET

Join Zoom Meeting
https://us04web.zoom.us/j/2504311919?pwd=WHpkS2pCOEVNRi85Znczc2lMeHYvQT09

Meeting ID: 250 431 1919
Passcode: 4jmxz0

I have also prepared a POSTMAN collection
<https://www.postman.com/collection/> with API request examples that I'll
be walking you through. You can import it on your local workspace. Please
follow the link below.

https://www.getpostman.com/collections/5ef56c4f090b715112bc

Best,
Girish

On Wed, Sep 30, 2020 at 9:07 PM Girish Vasmatkar <
[hidden email]> wrote:

> Hi Everyone!
>
> Please find details of the next session I am planning to hold on OFBiz
> REST implementation. This will have some hands-on examples that will help
> everyone using it.
>
> Date :  10/07/2020
> Time :  4 PM IST, 12:30 PM CET
> Meeting URL : TBD, I will send the invite link the day before.
> Agenda :
>
> 1. Preconfigured Resources (Resources that come OTB)
>
>    -
>
>    Authentication Token Generating Resource (How to invoke and example
>    usage)
>    -
>
>       POST /auth/token
>       -
>
>    Exportable Services Resource (How to call services with export=true
>    via REST interface with example usage)
>    -
>
>       GET | POST | PUT | DELETE | PATCH /services/{serviceName}
>       -
>
>       GET vs POST service in parameters difference. How to invoke service
>       defined as GET vs POST | POST | PATCH.
>       -
>
>    OpenAPI Resource
>    -
>
>       GET /openapi.json
>       -
>
>       GET /openapi.yaml
>       -
>
>    WADL Resource (WADL is to REST as  WSDL is to SOAP)
>    -
>
>       GET /application.wadl
>
> 2.  Standard API responses supported for various use cases (with examples)
> and how to interpret them.
>
>    -
>
>    HTTP 200 OK
>    -
>
>    HTTP 400 Bad Request
>    -
>
>    HTTP 401 Unauthorized
>    -
>
>    HTTP 403 Forbidden
>    -
>
>    HTTP 422 Unprocessable Entity
>    -
>
>    HTTP 405 Method Not Allowed
>    -
>
>    HTTP 406 Not Acceptable
>    -
>
>    HTTP 415 Unsupported Media Type
>
> 3. Content Negotiation (JSON)
>
>    -
>
>    Accept : application/json
>    -
>
>    Content-Type : application/json
>
> 4. Q&A session
>
> Best,
> Girish Vasmatkar
>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz REST implementation session #2 (10/07/2020)

Deepak Dixit-5
Thanks Girissh for update.

Thanks & Regards
--
Deepak Dixit
ofbiz.apache.org


On Tue, Oct 6, 2020 at 7:45 PM Girish Vasmatkar <
[hidden email]> wrote:

> Hi All
>
> Please note the meeting details for tomorrow's session -
>
> Topic: REST Session #2
> Time: Oct 7, 2020 04:00 PM Mumbai, Kolkata, New Delhi, 12:30 PM CET
>
> Join Zoom Meeting
> https://us04web.zoom.us/j/2504311919?pwd=WHpkS2pCOEVNRi85Znczc2lMeHYvQT09
>
> Meeting ID: 250 431 1919
> Passcode: 4jmxz0
>
> I have also prepared a POSTMAN collection
> <https://www.postman.com/collection/> with API request examples that I'll
> be walking you through. You can import it on your local workspace. Please
> follow the link below.
>
> https://www.getpostman.com/collections/5ef56c4f090b715112bc
>
> Best,
> Girish
>
> On Wed, Sep 30, 2020 at 9:07 PM Girish Vasmatkar <
> [hidden email]> wrote:
>
> > Hi Everyone!
> >
> > Please find details of the next session I am planning to hold on OFBiz
> > REST implementation. This will have some hands-on examples that will help
> > everyone using it.
> >
> > Date :  10/07/2020
> > Time :  4 PM IST, 12:30 PM CET
> > Meeting URL : TBD, I will send the invite link the day before.
> > Agenda :
> >
> > 1. Preconfigured Resources (Resources that come OTB)
> >
> >    -
> >
> >    Authentication Token Generating Resource (How to invoke and example
> >    usage)
> >    -
> >
> >       POST /auth/token
> >       -
> >
> >    Exportable Services Resource (How to call services with export=true
> >    via REST interface with example usage)
> >    -
> >
> >       GET | POST | PUT | DELETE | PATCH /services/{serviceName}
> >       -
> >
> >       GET vs POST service in parameters difference. How to invoke service
> >       defined as GET vs POST | POST | PATCH.
> >       -
> >
> >    OpenAPI Resource
> >    -
> >
> >       GET /openapi.json
> >       -
> >
> >       GET /openapi.yaml
> >       -
> >
> >    WADL Resource (WADL is to REST as  WSDL is to SOAP)
> >    -
> >
> >       GET /application.wadl
> >
> > 2.  Standard API responses supported for various use cases (with
> examples)
> > and how to interpret them.
> >
> >    -
> >
> >    HTTP 200 OK
> >    -
> >
> >    HTTP 400 Bad Request
> >    -
> >
> >    HTTP 401 Unauthorized
> >    -
> >
> >    HTTP 403 Forbidden
> >    -
> >
> >    HTTP 422 Unprocessable Entity
> >    -
> >
> >    HTTP 405 Method Not Allowed
> >    -
> >
> >    HTTP 406 Not Acceptable
> >    -
> >
> >    HTTP 415 Unsupported Media Type
> >
> > 3. Content Negotiation (JSON)
> >
> >    -
> >
> >    Accept : application/json
> >    -
> >
> >    Content-Type : application/json
> >
> > 4. Q&A session
> >
> > Best,
> > Girish Vasmatkar
> >
> >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz REST implementation session #2 (10/07/2020)

Deepak Dixit-5
Thanks Girish for the informative session.


Thanks & Regards
--
Deepak Dixit
ofbiz.apache.org


On Wed, Oct 7, 2020 at 4:04 PM Deepak Dixit <[hidden email]> wrote:

> Thanks Girissh for update.
>
> Thanks & Regards
> --
> Deepak Dixit
> ofbiz.apache.org
>
>
> On Tue, Oct 6, 2020 at 7:45 PM Girish Vasmatkar <
> [hidden email]> wrote:
>
>> Hi All
>>
>> Please note the meeting details for tomorrow's session -
>>
>> Topic: REST Session #2
>> Time: Oct 7, 2020 04:00 PM Mumbai, Kolkata, New Delhi, 12:30 PM CET
>>
>> Join Zoom Meeting
>> https://us04web.zoom.us/j/2504311919?pwd=WHpkS2pCOEVNRi85Znczc2lMeHYvQT09
>>
>> Meeting ID: 250 431 1919
>> Passcode: 4jmxz0
>>
>> I have also prepared a POSTMAN collection
>> <https://www.postman.com/collection/> with API request examples that I'll
>> be walking you through. You can import it on your local workspace. Please
>> follow the link below.
>>
>> https://www.getpostman.com/collections/5ef56c4f090b715112bc
>>
>> Best,
>> Girish
>>
>> On Wed, Sep 30, 2020 at 9:07 PM Girish Vasmatkar <
>> [hidden email]> wrote:
>>
>> > Hi Everyone!
>> >
>> > Please find details of the next session I am planning to hold on OFBiz
>> > REST implementation. This will have some hands-on examples that will
>> help
>> > everyone using it.
>> >
>> > Date :  10/07/2020
>> > Time :  4 PM IST, 12:30 PM CET
>> > Meeting URL : TBD, I will send the invite link the day before.
>> > Agenda :
>> >
>> > 1. Preconfigured Resources (Resources that come OTB)
>> >
>> >    -
>> >
>> >    Authentication Token Generating Resource (How to invoke and example
>> >    usage)
>> >    -
>> >
>> >       POST /auth/token
>> >       -
>> >
>> >    Exportable Services Resource (How to call services with export=true
>> >    via REST interface with example usage)
>> >    -
>> >
>> >       GET | POST | PUT | DELETE | PATCH /services/{serviceName}
>> >       -
>> >
>> >       GET vs POST service in parameters difference. How to invoke
>> service
>> >       defined as GET vs POST | POST | PATCH.
>> >       -
>> >
>> >    OpenAPI Resource
>> >    -
>> >
>> >       GET /openapi.json
>> >       -
>> >
>> >       GET /openapi.yaml
>> >       -
>> >
>> >    WADL Resource (WADL is to REST as  WSDL is to SOAP)
>> >    -
>> >
>> >       GET /application.wadl
>> >
>> > 2.  Standard API responses supported for various use cases (with
>> examples)
>> > and how to interpret them.
>> >
>> >    -
>> >
>> >    HTTP 200 OK
>> >    -
>> >
>> >    HTTP 400 Bad Request
>> >    -
>> >
>> >    HTTP 401 Unauthorized
>> >    -
>> >
>> >    HTTP 403 Forbidden
>> >    -
>> >
>> >    HTTP 422 Unprocessable Entity
>> >    -
>> >
>> >    HTTP 405 Method Not Allowed
>> >    -
>> >
>> >    HTTP 406 Not Acceptable
>> >    -
>> >
>> >    HTTP 415 Unsupported Media Type
>> >
>> > 3. Content Negotiation (JSON)
>> >
>> >    -
>> >
>> >    Accept : application/json
>> >    -
>> >
>> >    Content-Type : application/json
>> >
>> > 4. Q&A session
>> >
>> > Best,
>> > Girish Vasmatkar
>> >
>> >
>> >
>>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz REST implementation session #2 (10/07/2020)

Michael Brohl-3
In reply to this post by grv
Hi Girish,

can you give us a resume about the state of the REST plugin
implementation? Haven't heard about it in a while.

One specific question: does the implementation support getting
ressources "the REST way" like

    GET https://domain.tld/rest/services/getProduct/10000

instead of

    GET https://domain.tld/rest/services/getProduct?productId=10000

?

Or, even better

    GET https://domain.tld/rest/product/10000

?

Thanks for an update,

Michael Brohl

ecomify GmbH - www.ecomify.de


Am 06.10.20 um 16:15 schrieb Girish Vasmatkar:

> Hi All
>
> Please note the meeting details for tomorrow's session -
>
> Topic: REST Session #2
> Time: Oct 7, 2020 04:00 PM Mumbai, Kolkata, New Delhi, 12:30 PM CET
>
> Join Zoom Meeting
> https://us04web.zoom.us/j/2504311919?pwd=WHpkS2pCOEVNRi85Znczc2lMeHYvQT09
>
> Meeting ID: 250 431 1919
> Passcode: 4jmxz0
>
> I have also prepared a POSTMAN collection
> <https://www.postman.com/collection/> with API request examples that I'll
> be walking you through. You can import it on your local workspace. Please
> follow the link below.
>
> https://www.getpostman.com/collections/5ef56c4f090b715112bc
>
> Best,
> Girish
>
> On Wed, Sep 30, 2020 at 9:07 PM Girish Vasmatkar <
> [hidden email]> wrote:
>
>> Hi Everyone!
>>
>> Please find details of the next session I am planning to hold on OFBiz
>> REST implementation. This will have some hands-on examples that will help
>> everyone using it.
>>
>> Date :  10/07/2020
>> Time :  4 PM IST, 12:30 PM CET
>> Meeting URL : TBD, I will send the invite link the day before.
>> Agenda :
>>
>> 1. Preconfigured Resources (Resources that come OTB)
>>
>>     -
>>
>>     Authentication Token Generating Resource (How to invoke and example
>>     usage)
>>     -
>>
>>        POST /auth/token
>>        -
>>
>>     Exportable Services Resource (How to call services with export=true
>>     via REST interface with example usage)
>>     -
>>
>>        GET | POST | PUT | DELETE | PATCH /services/{serviceName}
>>        -
>>
>>        GET vs POST service in parameters difference. How to invoke service
>>        defined as GET vs POST | POST | PATCH.
>>        -
>>
>>     OpenAPI Resource
>>     -
>>
>>        GET /openapi.json
>>        -
>>
>>        GET /openapi.yaml
>>        -
>>
>>     WADL Resource (WADL is to REST as  WSDL is to SOAP)
>>     -
>>
>>        GET /application.wadl
>>
>> 2.  Standard API responses supported for various use cases (with examples)
>> and how to interpret them.
>>
>>     -
>>
>>     HTTP 200 OK
>>     -
>>
>>     HTTP 400 Bad Request
>>     -
>>
>>     HTTP 401 Unauthorized
>>     -
>>
>>     HTTP 403 Forbidden
>>     -
>>
>>     HTTP 422 Unprocessable Entity
>>     -
>>
>>     HTTP 405 Method Not Allowed
>>     -
>>
>>     HTTP 406 Not Acceptable
>>     -
>>
>>     HTTP 415 Unsupported Media Type
>>
>> 3. Content Negotiation (JSON)
>>
>>     -
>>
>>     Accept : application/json
>>     -
>>
>>     Content-Type : application/json
>>
>> 4. Q&A session
>>
>> Best,
>> Girish Vasmatkar
>>
>>
>>
grv
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz REST implementation session #2 (10/07/2020)

grv
Hi Michael

Please take a look at below thread where I have detailed information about
the XML DSL that supports complete REST like URIs

https://lists.apache.org/thread.html/re84e0c591c94464f1803013837ec9871067132681eeaa8afecef9759%40%3Cdev.ofbiz.apache.org%3E

OFBiz services with export=true and action (CRUD) defined on them, can be
accessed like -

GET https://domain.tld/rest/services/getProduct?productId=10000

While if you use XML DSL, you can actually define an endpoint that gets you
a product like this -

GET https://domain.tld/rest/products/10000
<https://domain.tld/rest/product/10000>

There are certain improvements like adding XML support, HTTP Caching that I
would still like to add but that is something does not affect the APIs as
such.

I am available for any help, issue or concern you may have.

Best Regards,
Girish



















On Thu, Feb 25, 2021 at 11:10 PM Michael Brohl <[hidden email]>
wrote:

> Hi Girish,
>
> can you give us a resume about the state of the REST plugin
> implementation? Haven't heard about it in a while.
>
> One specific question: does the implementation support getting
> ressources "the REST way" like
>
>     GET https://domain.tld/rest/services/getProduct/10000
>
> instead of
>
>     GET https://domain.tld/rest/services/getProduct?productId=10000
>
> ?
>
> Or, even better
>
>     GET https://domain.tld/rest/product/10000
>
> ?
>
> Thanks for an update,
>
> Michael Brohl
>
> ecomify GmbH - www.ecomify.de
>
>
> Am 06.10.20 um 16:15 schrieb Girish Vasmatkar:
> > Hi All
> >
> > Please note the meeting details for tomorrow's session -
> >
> > Topic: REST Session #2
> > Time: Oct 7, 2020 04:00 PM Mumbai, Kolkata, New Delhi, 12:30 PM CET
> >
> > Join Zoom Meeting
> >
> https://us04web.zoom.us/j/2504311919?pwd=WHpkS2pCOEVNRi85Znczc2lMeHYvQT09
> >
> > Meeting ID: 250 431 1919
> > Passcode: 4jmxz0
> >
> > I have also prepared a POSTMAN collection
> > <https://www.postman.com/collection/> with API request examples that
> I'll
> > be walking you through. You can import it on your local workspace. Please
> > follow the link below.
> >
> > https://www.getpostman.com/collections/5ef56c4f090b715112bc
> >
> > Best,
> > Girish
> >
> > On Wed, Sep 30, 2020 at 9:07 PM Girish Vasmatkar <
> > [hidden email]> wrote:
> >
> >> Hi Everyone!
> >>
> >> Please find details of the next session I am planning to hold on OFBiz
> >> REST implementation. This will have some hands-on examples that will
> help
> >> everyone using it.
> >>
> >> Date :  10/07/2020
> >> Time :  4 PM IST, 12:30 PM CET
> >> Meeting URL : TBD, I will send the invite link the day before.
> >> Agenda :
> >>
> >> 1. Preconfigured Resources (Resources that come OTB)
> >>
> >>     -
> >>
> >>     Authentication Token Generating Resource (How to invoke and example
> >>     usage)
> >>     -
> >>
> >>        POST /auth/token
> >>        -
> >>
> >>     Exportable Services Resource (How to call services with export=true
> >>     via REST interface with example usage)
> >>     -
> >>
> >>        GET | POST | PUT | DELETE | PATCH /services/{serviceName}
> >>        -
> >>
> >>        GET vs POST service in parameters difference. How to invoke
> service
> >>        defined as GET vs POST | POST | PATCH.
> >>        -
> >>
> >>     OpenAPI Resource
> >>     -
> >>
> >>        GET /openapi.json
> >>        -
> >>
> >>        GET /openapi.yaml
> >>        -
> >>
> >>     WADL Resource (WADL is to REST as  WSDL is to SOAP)
> >>     -
> >>
> >>        GET /application.wadl
> >>
> >> 2.  Standard API responses supported for various use cases (with
> examples)
> >> and how to interpret them.
> >>
> >>     -
> >>
> >>     HTTP 200 OK
> >>     -
> >>
> >>     HTTP 400 Bad Request
> >>     -
> >>
> >>     HTTP 401 Unauthorized
> >>     -
> >>
> >>     HTTP 403 Forbidden
> >>     -
> >>
> >>     HTTP 422 Unprocessable Entity
> >>     -
> >>
> >>     HTTP 405 Method Not Allowed
> >>     -
> >>
> >>     HTTP 406 Not Acceptable
> >>     -
> >>
> >>     HTTP 415 Unsupported Media Type
> >>
> >> 3. Content Negotiation (JSON)
> >>
> >>     -
> >>
> >>     Accept : application/json
> >>     -
> >>
> >>     Content-Type : application/json
> >>
> >> 4. Q&A session
> >>
> >> Best,
> >> Girish Vasmatkar
> >>
> >>
> >>
>