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

Shi Jinghai commented on OFBIZ-4274:
------------------------------------

Yes, swagger is suitable for api document. We're using swagger as api document. 
As trying to contribute a webpos2 component, I'm cleaning the api and 
translating the document into English. Our swagger doc in yaml format, it's 
more convenient than json format. We haven't used swagger as a validator until 
now.

The only problem I met is on expressing OFBiz auth, I don't know how to define 
a http or https path in openapi spec. 

!swagger-pos-openapi.png!

> Implement a REST Servlet
> ------------------------
>
>                 Key: OFBIZ-4274
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-4274
>             Project: OFBiz
>          Issue Type: New Feature
>          Components: framework
>    Affects Versions: Trunk
>            Reporter: Adrian Crum
>            Priority: Minor
>              Labels: REST
>         Attachments: RestExampleSchema.xsd, RestXmlRepresentation.xml, 
> rest-conf.xml, swagger-pos-openapi.png
>
>
> Implement a REST servlet that will map REST requests to OFBiz services. 
> Details are in the comments.
> [here is the discussion which took place on the dev 
> ML|http://markmail.org/message/ai6q2fbksowaayn4]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to