You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2016/07/14 10:44:09 UTC

[36/38] isis git commit: ISIS-1353: updates website with screenshots of swagger-ui

ISIS-1353: updates website with screenshots of swagger-ui


Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/0bda7461
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/0bda7461
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/0bda7461

Branch: refs/heads/master
Commit: 0bda7461fa7c23e3d277e7558cf8fac01d99b43b
Parents: c2f335d
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Thu Jul 14 11:33:27 2016 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Jul 14 11:33:27 2016 +0100

----------------------------------------------------------------------
 .../images/isis-in-pictures/205-swagger-ui.png  | Bin 0 -> 138809 bytes
 .../main/asciidoc/images/todoapp/swagger-ui.png | Bin 0 -> 105485 bytes
 .../documentation/src/main/asciidoc/index.html  |  20 ++++++++++++++++---
 .../src/main/asciidoc/isis-in-pictures.adoc     |  11 ++++++++--
 4 files changed, 26 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis/blob/0bda7461/adocs/documentation/src/main/asciidoc/images/isis-in-pictures/205-swagger-ui.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-in-pictures/205-swagger-ui.png b/adocs/documentation/src/main/asciidoc/images/isis-in-pictures/205-swagger-ui.png
new file mode 100644
index 0000000..e940d13
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/images/isis-in-pictures/205-swagger-ui.png differ

http://git-wip-us.apache.org/repos/asf/isis/blob/0bda7461/adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png b/adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png
new file mode 100644
index 0000000..32239ae
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png differ

http://git-wip-us.apache.org/repos/asf/isis/blob/0bda7461/adocs/documentation/src/main/asciidoc/index.html
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/index.html b/adocs/documentation/src/main/asciidoc/index.html
index c471e75..62fe96d 100644
--- a/adocs/documentation/src/main/asciidoc/index.html
+++ b/adocs/documentation/src/main/asciidoc/index.html
@@ -612,7 +612,7 @@ And I must say this: "Great Support from the development team"</p>
                     <div class="large-12 medium-12 columns">
                         <div class="description">
                            <h3 class="legend">Domain Driven Applications, Quickly</h3>
-                            <p>Apache Isis&trade; is a framework for rapidly developing domain-driven apps in Java.  Write your business logic in entities, domain services or view models, and the framework dynamically generates a representation of that domain model as a webapp or a RESTful API.</p>
+                            <p>Apache Isis&trade; is a framework for rapidly developing domain-driven apps in Java.  Write your business logic in entities, domain services or view models, and the framework dynamically generates a representation of that domain model as a webapp or a rich hypermedia REST API.</p>
 
                             <p><a class="button btn btn-primary btn-lg learn-more" href="./documentation.html" role="button">Learn more �</a></p>
                         </div>
@@ -625,8 +625,8 @@ And I must say this: "Great Support from the development team"</p>
             <div class="container">
                 <div class="row">
                     <div class="large-4 medium-4 columns">
-                        <h2>UI "for free"</h2>
-                        <p>Apache Isis dynamically builds a generic UI directly from the underlying domain objects.
+                        <h2>UI &amp; REST "for free"</h2>
+                        <p>Apache Isis dynamically builds both a generic UI and also a rich hypermedia REST API directly from the underlying domain objects.
                             This makes for extremely rapid prototyping and a short feedback cycle, perfect for agile development.
                             The UI can also be extended for specific use cases, and can be themed using <a href="http://getbootstrap.com">Bootstrap</a>.</p>
                         <p><a class="button small info radius" href="./isis-in-pictures.html" role="button">See Apache Isis in action �</a></p>
@@ -682,6 +682,20 @@ And I must say this: "Great Support from the development team"</p>
 
                 <div class="row">
                     <div class="large-12 medium-12 columns">
+                        <br/>
+                        <br/>
+                        <p>Apache Isis also provides a rich REST API with a full set of hypermedia controls.  The framework provides two default representations, pluggable for other representations.  The framework also automatically generates a Swagger spec to allow REST clients to be code-generated, and (for developers) exposes the REST API through the Swagger UI:</p>
+                    </div>
+                </div>
+
+                <div class="row">
+                    <div class="large-offset-1 large-10 medium-offset-1 medium-10 columns">
+                        <a href="./images/todoapp/swagger-ui.png"><img src="./images/todoapp/swagger-ui.png" style="padding: 2px;border: 1px solid #021a40;" /></a>
+                    </div>
+                </div>
+
+                <div class="row">
+                    <div class="large-12 medium-12 columns">
                         <h4>Getting started</h4>
                         <br/>
                         <p>Start developing your own Apache Isis application using our <a href="guides/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp archetype</a>:</p>

http://git-wip-us.apache.org/repos/asf/isis/blob/0bda7461/adocs/documentation/src/main/asciidoc/isis-in-pictures.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/isis-in-pictures.adoc b/adocs/documentation/src/main/asciidoc/isis-in-pictures.adoc
index c219286..e76c418 100644
--- a/adocs/documentation/src/main/asciidoc/isis-in-pictures.adoc
+++ b/adocs/documentation/src/main/asciidoc/isis-in-pictures.adoc
@@ -223,13 +223,20 @@ image::{_imagesdir}/isis-in-pictures/190-switch-theme.png[width="800px",link="{_
 
 == REST API
 
-In addition to Apache Isis' Wicket viewer, it also provides a fully fledged REST API, as an implementation of the http://restfulobjects.org[Restful Objects] specification. The screenshot below shows accessing this REST API using a Chrome plugin:
+In addition to Apache Isis' Wicket viewer, it also provides a rich REST API with a full set of hypermedia controls, generated automatically from the domain objects (entities and view models).  The framework provides two default representations, one an implementation of the http://restfulobjects.org[Restful Objects] spec, the other a simplified representation suitable for custom Javascript apps.  Other representations can be plugged in.
+
+The screenshot below shows accessing the Restful Objects representation API accessed through a Chrome plugin:
 
 image::{_imagesdir}/isis-in-pictures/200-rest-api.png[width="800px",link="{_imagesdir}/isis-in-pictures/200-rest-api.png"]
 
 
+The framework also automatically integrates with Swagger, generating a Swagger spec from the underlying domain object model.  From this spec REST clients can be code-generated; it also allows developers to play with the REST API through the Swagger UI:
+
+
+image::{_imagesdir}/isis-in-pictures/205-swagger-ui.png[width="800px",link="{_imagesdir}/isis-in-pictures/205-swagger-ui.png"]
+
+
 
-Like the Wicket viewer, the REST API is generated automatically from the domain objects (entities and view models).