You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@isis.apache.org by "Dan Haywood (JIRA)" <ji...@apache.org> on 2015/12/01 23:21:10 UTC
[jira] [Commented] (ISIS-1237) Integrate with swagger for REST APIs
[ https://issues.apache.org/jira/browse/ISIS-1237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15034715#comment-15034715 ]
Dan Haywood commented on ISIS-1237:
-----------------------------------
have attached a hand-crafted swagger spec for the simpleapp. This was built using the online editor, http://editor.swagger.io/#/.
Portions of this spec would be generated by recursing the metamodel; in particular note:
- a separate definition for each service, because each will expose different actions
- a separate definition for each domain object, because each will expose different members (properties/collections/actions)
- that the properties for SimpleObject are enumerated explicitly, because each has a different type for "value"
~~~~~~
This piece of work should also incorporate:
a) hosting https://github.com/swagger-api/swagger-ui to avoid CORS / allow exploration
b) generate Angular stubs from a spec, via a maven plugin, https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin
> Integrate with swagger for REST APIs
> ------------------------------------
>
> Key: ISIS-1237
> URL: https://issues.apache.org/jira/browse/ISIS-1237
> Project: Isis
> Issue Type: Improvement
> Components: Core
> Affects Versions: 1.9.0
> Reporter: Dan Haywood
> Assignee: Dan Haywood
> Priority: Minor
> Fix For: 1.11.0
>
> Attachments: hand-crafted-swagger-spec-for-simpleapp.yaml
>
>
> as per Oscar's mail:
> You know we're using Wavemaker for the front-end.
> Most recent version 7 uses Swagger as the way to document the auto-generated APIs [1], but all JavaScript widgets can be render any JSON representation with limitations detailed in [2], [3].
> [1] http://www.wavemaker.com/latest/wavemaker-api-designer-brings-api-driven-development-to-custom-built-enterprise-applications/
> [2] http://www.wavemaker.com/learn/topics/studio/integrate/external-services/
> [3]
> http://www.wavemaker.com/learn/docs/importing-web-services/
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)