You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by mg...@apache.org on 2015/12/13 10:38:15 UTC
[36/50] [abbrv] isis git commit: ISIS-1237: a little more work on
SwaggerService;
can also access swagger-ui using /api-docs/index.html, hitting the internal
/restful/swagger/private URL to access the swagger spec itself.
ISIS-1237: a little more work on SwaggerService; can also access swagger-ui using /api-docs/index.html, hitting the internal /restful/swagger/private URL to access the swagger spec itself.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/86b960ac
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/86b960ac
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/86b960ac
Branch: refs/heads/ISIS-1223-upgrade-to-wicket-7
Commit: 86b960ac88079bd23c91eaf13ccc01d4d11a758f
Parents: 72cae2f
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Wed Dec 9 00:19:57 2015 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Wed Dec 9 00:19:57 2015 +0000
----------------------------------------------------------------------
.../applib/services/swagger/SwaggerService.java | 22 +-
.../services/swagger/SwaggerServiceMenu.java | 18 +-
.../isis/applib/services/swagger/Util.java | 15 +-
core/metamodel/pom.xml | 6 +
.../services/swagger/SwaggerServiceDefault.java | 14 +-
.../services/swagger/internal/SwaggerSpec.java | 259 --------------
.../swagger/internal/SwaggerSpecGenerator.java | 356 +++++++++++++++++++
core/viewer-restfulobjects-server/pom.xml | 11 +
.../server/RestfulObjectsApplication.java | 3 +
.../server/resources/SwaggerSpecResource.java | 125 +++++++
example/application/simpleapp/webapp/pom.xml | 1 -
.../webapp/src/main/webapp/WEB-INF/web.xml | 17 +-
.../webapp/src/main/webapp/api-docs/index.html | 130 +++++++
13 files changed, 699 insertions(+), 278 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerService.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerService.java b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerService.java
index 901cc62..c25d23f 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerService.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerService.java
@@ -21,11 +21,10 @@ import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.NatureOfService;
import org.apache.isis.applib.annotation.RestrictTo;
import org.apache.isis.applib.annotation.ViewModel;
-import org.apache.isis.applib.value.Clob;
public interface SwaggerService {
- public enum Type {
+ enum Visibility {
/**
* Specification for use by third-party clients, ie public use.
*
@@ -52,11 +51,22 @@ public interface SwaggerService {
public boolean isPublic() {
return this == PUBLIC;
}
- public boolean isPrivateWithPrototyping() {
- return this == PRIVATE_WITH_PROTOTYPING;
- }
}
- public Clob downloadSwaggerSpec(final String fileName, final Type type);
+ enum Format {
+ JSON {
+ @Override public String mediaType() {
+ return "text/json";
+ }
+ },
+ YAML {
+ @Override public String mediaType() {
+ return "application/yaml";
+ }
+ };
+
+ public abstract String mediaType();
+ }
+ String generateSwaggerSpec(final Visibility visibility, final Format format);
}
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerServiceMenu.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerServiceMenu.java b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerServiceMenu.java
index d1e72b0..7b4e4b0 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerServiceMenu.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/SwaggerServiceMenu.java
@@ -57,11 +57,23 @@ public class SwaggerServiceMenu {
@MemberOrder(sequence="500.800.1")
public Clob downloadSwaggerSpec(
@ParameterLayout(named = "Filename")
- final String fileName,
- final SwaggerService.Type type) {
- return swaggerService.downloadSwaggerSpec(Util.withSuffix(fileName, "json"), type);
+ final String fileNamePrefix,
+ final SwaggerService.Visibility visibility,
+ final SwaggerService.Format format) {
+ final String fileName = Util.buildFileName(fileNamePrefix, visibility, format);
+ final String spec = swaggerService.generateSwaggerSpec(visibility, format);
+ return new Clob(fileName, format.mediaType(), spec);
}
+ public String default0DownloadSwaggerSpec() {
+ return "swagger";
+ }
+ public SwaggerService.Visibility default1DownloadSwaggerSpec() {
+ return SwaggerService.Visibility.PRIVATE;
+ }
+ public SwaggerService.Format default2DownloadSwaggerSpec() {
+ return SwaggerService.Format.YAML;
+ }
@Inject
SwaggerService swaggerService;
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/applib/src/main/java/org/apache/isis/applib/services/swagger/Util.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/Util.java b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/Util.java
index ec07c7f..81af662 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/swagger/Util.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/swagger/Util.java
@@ -20,7 +20,19 @@ class Util {
private Util(){}
- static String withSuffix(String fileName, String suffix) {
+ static String buildFileName(
+ String fileNamePrefix,
+ final SwaggerService.Visibility visibility,
+ final SwaggerService.Format format) {
+ final String formatLower = format.name().toLowerCase();
+ int i = fileNamePrefix.lastIndexOf("." + formatLower);
+ if(i > 0) {
+ fileNamePrefix = fileNamePrefix.substring(0, i);
+ }
+ return withSuffix(fileNamePrefix + "-" + visibility.name().toLowerCase(), formatLower);
+ }
+
+ private static String withSuffix(String fileName, String suffix) {
if(!suffix.startsWith(".")) {
suffix = "." + suffix;
}
@@ -30,4 +42,5 @@ class Util {
return fileName;
}
+
}
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/metamodel/pom.xml
----------------------------------------------------------------------
diff --git a/core/metamodel/pom.xml b/core/metamodel/pom.xml
index 629b0a2..4ef1588 100644
--- a/core/metamodel/pom.xml
+++ b/core/metamodel/pom.xml
@@ -97,6 +97,12 @@
<groupId>io.swagger</groupId>
<artifactId>swagger-core</artifactId>
<version>1.5.4</version>
+ <exclusions>
+ <exclusion>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-lang3</artifactId>
+ </exclusion>
+ </exclusions>
</dependency>
</dependencies>
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/SwaggerServiceDefault.java
----------------------------------------------------------------------
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/SwaggerServiceDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/SwaggerServiceDefault.java
index fbf3737..c447788 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/SwaggerServiceDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/SwaggerServiceDefault.java
@@ -24,8 +24,7 @@ import org.slf4j.LoggerFactory;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.NatureOfService;
import org.apache.isis.applib.services.swagger.SwaggerService;
-import org.apache.isis.applib.value.Clob;
-import org.apache.isis.core.metamodel.services.swagger.internal.SwaggerSpec;
+import org.apache.isis.core.metamodel.services.swagger.internal.SwaggerSpecGenerator;
import org.apache.isis.core.metamodel.spec.SpecificationLoader;
import org.apache.isis.core.metamodel.spec.SpecificationLoaderAware;
@@ -38,12 +37,13 @@ public class SwaggerServiceDefault implements SwaggerService, SpecificationLoade
private final static Logger LOG = LoggerFactory.getLogger(SwaggerServiceDefault.class);
@Override
- public Clob downloadSwaggerSpec(final String fileName, final Type type) {
+ public String generateSwaggerSpec(
+ final Visibility visibility,
+ final Format format) {
- SwaggerSpec swaggerSpec = new SwaggerSpec(specificationLoader);
-
- String yaml = swaggerSpec.generate(type);
- return new Clob(fileName, "text/json", yaml);
+ final SwaggerSpecGenerator swaggerSpecGenerator = new SwaggerSpecGenerator(specificationLoader);
+ final String swaggerSpec = swaggerSpecGenerator.generate(visibility, format);
+ return swaggerSpec;
}
//region > injected dependencies
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpec.java
----------------------------------------------------------------------
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpec.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpec.java
deleted file mode 100644
index a62c236..0000000
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpec.java
+++ /dev/null
@@ -1,259 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-package org.apache.isis.core.metamodel.services.swagger.internal;
-
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.List;
-
-import org.apache.isis.applib.annotation.NatureOfService;
-import org.apache.isis.applib.filter.Filters;
-import org.apache.isis.applib.services.swagger.SwaggerService;
-import org.apache.isis.core.metamodel.facets.object.domainservice.DomainServiceFacet;
-import org.apache.isis.core.metamodel.spec.ActionType;
-import org.apache.isis.core.metamodel.spec.ObjectSpecification;
-import org.apache.isis.core.metamodel.spec.SpecificationLoader;
-import org.apache.isis.core.metamodel.spec.feature.Contributed;
-import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
-
-import io.swagger.models.Info;
-import io.swagger.models.ModelImpl;
-import io.swagger.models.Operation;
-import io.swagger.models.Path;
-import io.swagger.models.Response;
-import io.swagger.models.Swagger;
-import io.swagger.models.properties.ArrayProperty;
-import io.swagger.models.properties.IntegerProperty;
-import io.swagger.models.properties.ObjectProperty;
-import io.swagger.models.properties.RefProperty;
-import io.swagger.models.properties.StringProperty;
-import io.swagger.util.Json;
-
-public class SwaggerSpec {
-
- private final SpecificationLoader specificationLoader;
-
- public SwaggerSpec(final SpecificationLoader specificationLoader) {
- this.specificationLoader = specificationLoader;
- }
-
- public String generate(final SwaggerService.Type type) {
- final Swagger swagger = new Swagger();
- swagger.info(new Info()
- .version("1.0.0")
- .title("Restful Objects"))
- .path("/",
- new Path()
- .get(new Operation()
- .description("RO Spec v1.0, section 5.1")
- .consumes("application/json")
- .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/home-page\"")
- .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/home-page\"")
- .response(200,
- newResponse(Caching.LONG_TERM)
- .description("OK")
- .schema(new RefProperty("#/definitions/home-page"))
- )))
- .path("/user",
- new Path()
- .get(new Operation()
- .description("RO Spec v1.0, section 6.1")
- .consumes("application/json")
- .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/user\"")
- .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/user\"")
- .response(200,
- newResponse(Caching.SHORT_TERM)
- .description("OK")
- .schema(new RefProperty("#/definitions/user"))
- )))
- .path("/version",
- new Path()
- .get(new Operation()
- .description("RO Spec v1.0, section 8.1")
- .consumes("application/json")
- .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/version\"")
- .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/version\"")
- .response(200,
- newResponse(Caching.LONG_TERM)
- .description("OK")
- .schema(new RefProperty("#/definitions/version"))
- )));
-
- swagger.addDefinition("home-page",
- new ModelImpl()
- .description("RO Spec v1.0, section 5.2")
- .type("object")
- .property("links", arrayOfLinksGetOnly())
- .required("links")
- );
-
- swagger.addDefinition("user",
- new ModelImpl()
- .description("RO Spec v1.0, section 6.2")
- .type("object")
- .property("userName", stringProperty())
- .property("roles", arrayOfStrings())
- .property("links", arrayOfLinksGetOnly())
- .required("userName")
- .required("roles")
- .required("links")
- );
-
- swagger.addDefinition("version",
- new ModelImpl()
- .description("RO Spec v1.0, section 8.2")
- .type("object")
- .property("specVersion", stringProperty())
- .property("implVersion", stringProperty())
- .property("optionalCapabilities",
- new ObjectProperty()
- .property("blobsClobs", stringProperty())
- .property("deleteObjects", stringProperty())
- .property("domainModel", stringProperty())
- .property("validateOnly", stringProperty())
- .property("protoPersistentObjects", stringProperty())
- )
- .property("links", arrayOfLinksGetOnly())
- .property("extensions", new ObjectProperty())
- .required("userName")
- .required("roles")
- .required("links")
- );
-
- swagger.addDefinition("link",
- new ModelImpl()
- .type("object")
- .property("rel", stringProperty())
- .property("href", stringProperty())
- .property("title", stringProperty())
- .property("method", stringPropertyEnum("GET", "POST", "PUT", "DELETE"))
- .property("type", stringProperty())
- .property("arguments", new ObjectProperty())
- .required("rel")
- .required("href")
- .required("method")
- );
-
- swagger.addDefinition("link-get-only",
- new ModelImpl()
- .type("object")
- .property("rel", stringProperty())
- .property("href", stringProperty())
- .property("title", stringProperty())
- .property("method", stringPropertyEnum("GET"))
- .property("type", stringProperty())
- .required("rel")
- .required("href")
- .required("method")
- );
-
-
- final Collection<ObjectSpecification> allSpecs = specificationLoader.allSpecifications();
- for (ObjectSpecification serviceSpec : allSpecs) {
- final DomainServiceFacet domainServiceFacet = serviceSpec.getFacet(DomainServiceFacet.class);
- if (domainServiceFacet == null) {
- continue;
- }
- if (type.isPublic() && domainServiceFacet.getNatureOfService() != NatureOfService.VIEW_REST_ONLY) {
- continue;
- }
-
- List<ObjectAction> serviceActions = serviceSpec
- .getObjectActions(actionTypesFor(type), Contributed.EXCLUDED, Filters.<ObjectAction>any());
- for (ObjectAction serviceAction : serviceActions) {
-
- }
-
- }
-
-
- return Json.pretty(swagger);
- }
-
- StringProperty stringPropertyEnum(String... enumValues) {
- StringProperty stringProperty = stringProperty();
- stringProperty._enum(Arrays.asList(enumValues));
- if(enumValues.length >= 1) {
- stringProperty._default(enumValues[0]);
- }
- return stringProperty;
- }
-
- ArrayProperty arrayOfLinksGetOnly() {
- return new ArrayProperty()
- .items(new RefProperty("#/definitions/link-get-only"));
- }
-
- StringProperty stringProperty() {
- return new StringProperty();
- }
-
- ArrayProperty arrayOfStrings() {
- return new ArrayProperty().items(stringProperty());
- }
-
- private Response newResponse(final Caching caching) {
- return withCachingHeaders(new Response(), caching);
- }
-
- enum Caching {
- NO_CACHING {
- @Override public void withHeaders(final Response response) {
-
- }
- },
- SHORT_TERM {
- @Override public void withHeaders(final Response response) {
- response
- .header("Cache-Control",
- new IntegerProperty()
- ._default(3600));
- }
- },
- LONG_TERM {
- @Override public void withHeaders(final Response response) {
- response
- .header("Cache-Control",
- new IntegerProperty()
- ._default(86400));
- }
- };
-
- public abstract void withHeaders(final Response response);
- }
- private Response withCachingHeaders(final Response response, final Caching caching) {
- caching.withHeaders(response);
-
- return response;
- }
-
- private List<ActionType> actionTypesFor(final SwaggerService.Type type) {
- switch (type) {
- case PUBLIC:
- return Arrays.asList(ActionType.USER);
- case PRIVATE:
- return Arrays.asList(ActionType.USER);
- case PRIVATE_WITH_PROTOTYPING:
- return Arrays.asList(ActionType.USER, ActionType.EXPLORATION, ActionType.PROTOTYPE, ActionType.DEBUG);
- }
- throw new IllegalArgumentException("Unrecognized type '" + type + "'");
- }
-
-
-}
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpecGenerator.java
----------------------------------------------------------------------
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpecGenerator.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpecGenerator.java
new file mode 100644
index 0000000..0e729ec
--- /dev/null
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/SwaggerSpecGenerator.java
@@ -0,0 +1,356 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.isis.core.metamodel.services.swagger.internal;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+import org.apache.isis.applib.annotation.NatureOfService;
+import org.apache.isis.applib.filter.Filters;
+import org.apache.isis.applib.services.swagger.SwaggerService;
+import org.apache.isis.core.commons.factory.InstanceUtil;
+import org.apache.isis.core.metamodel.facets.object.domainservice.DomainServiceFacet;
+import org.apache.isis.core.metamodel.services.ServiceUtil;
+import org.apache.isis.core.metamodel.spec.ActionType;
+import org.apache.isis.core.metamodel.spec.ObjectSpecification;
+import org.apache.isis.core.metamodel.spec.SpecificationLoader;
+import org.apache.isis.core.metamodel.spec.feature.Contributed;
+import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
+
+import io.swagger.models.Info;
+import io.swagger.models.ModelImpl;
+import io.swagger.models.Operation;
+import io.swagger.models.Path;
+import io.swagger.models.Response;
+import io.swagger.models.Swagger;
+import io.swagger.models.properties.ArrayProperty;
+import io.swagger.models.properties.IntegerProperty;
+import io.swagger.models.properties.MapProperty;
+import io.swagger.models.properties.ObjectProperty;
+import io.swagger.models.properties.RefProperty;
+import io.swagger.models.properties.StringProperty;
+import io.swagger.util.Json;
+import io.swagger.util.Yaml;
+
+public class SwaggerSpecGenerator {
+
+ private final SpecificationLoader specificationLoader;
+
+ public SwaggerSpecGenerator(final SpecificationLoader specificationLoader) {
+ this.specificationLoader = specificationLoader;
+ }
+
+ public String generate(final SwaggerService.Visibility visibility, final SwaggerService.Format format) {
+ final Swagger swagger = new Swagger();
+ swagger.basePath("/restful");
+ swagger.info(new Info()
+ .version("1.0.0")
+ .title("Restful Objects"))
+ .path("/",
+ new Path()
+ .get(new Operation()
+ .description(roSpec("5.1"))
+ .consumes("application/json")
+ .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/home-page\"")
+ .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/home-page\"")
+ .response(200,
+ newResponse(Caching.NON_EXPIRING)
+ .description("OK")
+ .schema(new RefProperty("#/definitions/home-page"))
+ )))
+ .path("/user",
+ new Path()
+ .get(new Operation()
+ .description(roSpec("6.1"))
+ .consumes("application/json")
+ .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/user\"")
+ .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/user\"")
+ .response(200,
+ newResponse(Caching.USER_INFO)
+ .description("OK")
+ .schema(new RefProperty("#/definitions/user"))
+ )))
+ .path("/services",
+ new Path()
+ .get(new Operation()
+ .description(roSpec("7.1"))
+ .consumes("application/json")
+ .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/services\"")
+ .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/services\"")
+ .response(200,
+ newResponse(Caching.USER_INFO)
+ .description("OK")
+ .schema(new RefProperty("#/definitions/services"))
+ )))
+
+ .path("/version",
+ new Path()
+ .get(new Operation()
+ .description(roSpec("8.1"))
+ .consumes("application/json")
+ .consumes("application/json;profile=\"urn:org.restfulobjects:repr-types/version\"")
+ .produces("application/json;profile=\"urn:org.restfulobjects:repr-types/version\"")
+ .response(200,
+ newResponse(Caching.NON_EXPIRING)
+ .description("OK")
+ .schema(new RefProperty("#/definitions/version"))
+ )));
+
+ swagger.addDefinition("home-page",
+ newModel(roSpec("5.2")));
+
+ swagger.addDefinition("user",
+ newModel(roSpec("6.2"))
+ .property("userName", stringProperty())
+ .property("roles", arrayOfStrings())
+ .property("links", arrayOfLinksGetOnly())
+ .required("userName")
+ .required("roles")
+ );
+
+ swagger.addDefinition("services",
+ newModel(roSpec("7.2"))
+ .property("value", arrayOfLinksGetOnly())
+ .required("userName")
+ .required("roles")
+ );
+
+ swagger.addDefinition("version",
+ newModel(roSpec("8.2"))
+ .property("specVersion", stringProperty())
+ .property("implVersion", stringProperty())
+ .property("optionalCapabilities",
+ new ObjectProperty()
+ .property("blobsClobs", stringProperty())
+ .property("deleteObjects", stringProperty())
+ .property("domainModel", stringProperty())
+ .property("validateOnly", stringProperty())
+ .property("protoPersistentObjects", stringProperty())
+ )
+ .required("userName")
+ .required("roles")
+ );
+
+ swagger.addDefinition("link",
+ new ModelImpl()
+ .type("object")
+ .property("rel", stringProperty())
+ .property("href", stringProperty())
+ .property("title", stringProperty())
+ .property("method", stringPropertyEnum("GET", "POST", "PUT", "DELETE"))
+ .property("type", stringProperty())
+ .property("arguments", new ObjectProperty())
+ .required("rel")
+ .required("href")
+ .required("method")
+ );
+
+ swagger.addDefinition("link-get-only",
+ new ModelImpl()
+ .type("object")
+ .property("rel", stringProperty())
+ .property("href", stringProperty())
+ .property("title", stringProperty())
+ .property("method", stringPropertyEnum("GET"))
+ .property("type", stringProperty())
+ .required("rel")
+ .required("href")
+ .required("method")
+ );
+
+
+ final Collection<ObjectSpecification> allSpecs = specificationLoader.allSpecifications();
+ for (ObjectSpecification serviceSpec : allSpecs) {
+ final DomainServiceFacet domainServiceFacet = serviceSpec.getFacet(DomainServiceFacet.class);
+ if (domainServiceFacet == null) {
+ continue;
+ }
+ if (!isVisible(visibility, domainServiceFacet)) {
+ continue;
+ }
+
+ List<ObjectAction> serviceActions = serviceSpec
+ .getObjectActions(actionTypesFor(visibility), Contributed.EXCLUDED, Filters.<ObjectAction>any());
+ if(serviceActions.isEmpty()) {
+ continue;
+ }
+
+ String serviceId = serviceIdFor(serviceSpec);
+ final String serviceDefinitionId = "service-" + serviceId;
+
+ final Path servicePath = new Path();
+ swagger.path("/services/" + serviceId, servicePath);
+
+ servicePath.get(
+ new Operation()
+ .description(roSpec("15.1"))
+ .response(200,
+ newResponse(Caching.TRANSACTIONAL)
+ .description("OK")
+ .schema(new RefProperty("#/definitions/"
+ + serviceDefinitionId)))
+ );
+
+ final ObjectProperty serviceMembers = new ObjectProperty();
+ ModelImpl serviceRepr =
+ newModel(roSpec("15.1.2") + ": representation of " + serviceId)
+ .property("title", stringProperty())
+ .property("serviceId", stringProperty()._default(serviceId))
+ .property("members", serviceMembers);
+
+ swagger.addDefinition(serviceDefinitionId, serviceRepr);
+
+ for (final ObjectAction serviceAction : serviceActions) {
+ String serviceActionId = serviceAction.getId();
+ serviceMembers.property(serviceActionId,
+ new ObjectProperty()
+ .property("id", stringPropertyEnum(serviceActionId))
+ .property("memberType", stringPropertyEnum("action"))
+ .property("links",
+ new ObjectProperty()
+ .property("rel", stringPropertyEnum("urn:org.restfulobjects:rels/details;action=\"" + serviceActionId + "\""))
+ .property("href", stringPropertyEnum("actions/"
+ + serviceActionId)))
+ .property("method", stringPropertyEnum("GET"))
+ .property("type", stringPropertyEnum("application/json;profile=\"urn:org.restfulobjects:repr-types/object-action\""))
+ );
+ }
+
+ }
+
+ switch (format) {
+ case JSON:
+ return Json.pretty(swagger);
+ case YAML:
+ try {
+ return Yaml.pretty().writeValueAsString(swagger);
+ } catch (JsonProcessingException e) {
+ throw new RuntimeException(e);
+ }
+ default:
+ throw new IllegalArgumentException("Unrecognized format: " + format);
+ }
+ }
+
+ boolean isVisible(final SwaggerService.Visibility visibility, final DomainServiceFacet domainServiceFacet) {
+ if (domainServiceFacet.getNatureOfService() == NatureOfService.VIEW_REST_ONLY) {
+ return true;
+ }
+ if (visibility.isPublic()) {
+ return false;
+ }
+ return domainServiceFacet.getNatureOfService() == NatureOfService.VIEW_MENU_ONLY ||
+ domainServiceFacet.getNatureOfService() == NatureOfService.VIEW;
+ }
+
+ private ModelImpl newModel(final String description) {
+ return new ModelImpl()
+ .description(description)
+ .type("object")
+ .property("links", arrayOfLinksGetOnly())
+ .property("extensions", new MapProperty())
+ .required("links")
+ .required("extensions");
+ }
+
+ // TODO: this is horrid, there ought to be a facet we can call instead...
+ String serviceIdFor(final ObjectSpecification serviceSpec) {
+ Object tempServiceInstance = InstanceUtil.createInstance(serviceSpec.getCorrespondingClass());
+ return ServiceUtil.id(tempServiceInstance);
+ }
+
+ StringProperty stringProperty() {
+ return new StringProperty();
+ }
+
+ StringProperty stringPropertyEnum(String... enumValues) {
+ StringProperty stringProperty = stringProperty();
+ stringProperty._enum(Arrays.asList(enumValues));
+ if(enumValues.length >= 1) {
+ stringProperty._default(enumValues[0]);
+ }
+ return stringProperty;
+ }
+
+ ArrayProperty arrayOfLinksGetOnly() {
+ return new ArrayProperty()
+ .items(new RefProperty("#/definitions/link-get-only"));
+ }
+
+ ArrayProperty arrayOfStrings() {
+ return new ArrayProperty().items(stringProperty());
+ }
+
+ private Response newResponse(final Caching caching) {
+ return withCachingHeaders(new Response(), caching);
+ }
+
+ enum Caching {
+ TRANSACTIONAL {
+ @Override public void withHeaders(final Response response) {
+
+ }
+ },
+ USER_INFO {
+ @Override public void withHeaders(final Response response) {
+ response
+ .header("Cache-Control",
+ new IntegerProperty()
+ ._default(3600));
+ }
+ },
+ NON_EXPIRING {
+ @Override public void withHeaders(final Response response) {
+ response
+ .header("Cache-Control",
+ new IntegerProperty()
+ ._default(86400).description(roSpec("2.13")));
+ }
+ };
+
+ public abstract void withHeaders(final Response response);
+ }
+
+ private static String roSpec(final String section) {
+ return "RO Spec v1.0, section " + section;
+ }
+
+ private Response withCachingHeaders(final Response response, final Caching caching) {
+ caching.withHeaders(response);
+
+ return response;
+ }
+
+ private List<ActionType> actionTypesFor(final SwaggerService.Visibility visibility) {
+ switch (visibility) {
+ case PUBLIC:
+ return Arrays.asList(ActionType.USER);
+ case PRIVATE:
+ return Arrays.asList(ActionType.USER);
+ case PRIVATE_WITH_PROTOTYPING:
+ return Arrays.asList(ActionType.USER, ActionType.EXPLORATION, ActionType.PROTOTYPE, ActionType.DEBUG);
+ }
+ throw new IllegalArgumentException("Unrecognized type '" + visibility + "'");
+ }
+
+
+}
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/viewer-restfulobjects-server/pom.xml
----------------------------------------------------------------------
diff --git a/core/viewer-restfulobjects-server/pom.xml b/core/viewer-restfulobjects-server/pom.xml
index 17768a0..b833b59 100644
--- a/core/viewer-restfulobjects-server/pom.xml
+++ b/core/viewer-restfulobjects-server/pom.xml
@@ -61,5 +61,16 @@
<artifactId>geronimo-activation_1.1_spec</artifactId>
</dependency>
+ <dependency>
+ <groupId>org.webjars</groupId>
+ <artifactId>swagger-ui</artifactId>
+ <version>2.1.3</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.webjars</groupId>
+ <artifactId>webjars-servlet-2.x</artifactId>
+ <version>1.1</version>
+ </dependency>
</dependencies>
</project>
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/RestfulObjectsApplication.java
----------------------------------------------------------------------
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/RestfulObjectsApplication.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/RestfulObjectsApplication.java
index 7adc430..d1dbcc6 100644
--- a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/RestfulObjectsApplication.java
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/RestfulObjectsApplication.java
@@ -23,6 +23,7 @@ import org.apache.isis.viewer.restfulobjects.server.resources.DomainObjectResour
import org.apache.isis.viewer.restfulobjects.server.resources.DomainServiceResourceServerside;
import org.apache.isis.viewer.restfulobjects.server.resources.DomainTypeResourceServerside;
import org.apache.isis.viewer.restfulobjects.server.resources.HomePageResourceServerside;
+import org.apache.isis.viewer.restfulobjects.server.resources.SwaggerSpecResource;
import org.apache.isis.viewer.restfulobjects.server.resources.UserResourceServerside;
import org.apache.isis.viewer.restfulobjects.server.resources.VersionResourceServerside;
@@ -38,6 +39,8 @@ public class RestfulObjectsApplication extends AbstractJaxRsApplication {
addClass(DomainServiceResourceServerside.class);
addClass(VersionResourceServerside.class);
+ addClass(SwaggerSpecResource.class);
+
final RestfulObjectsJaxbWriterForXml roWriter = new RestfulObjectsJaxbWriterForXml();
addSingleton(roWriter);
addSingleton(new RestfulObjectsApplicationExceptionMapper());
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/SwaggerSpecResource.java
----------------------------------------------------------------------
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/SwaggerSpecResource.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/SwaggerSpecResource.java
new file mode 100644
index 0000000..4032013
--- /dev/null
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/SwaggerSpecResource.java
@@ -0,0 +1,125 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.isis.viewer.restfulobjects.server.resources;
+
+import java.util.List;
+import java.util.concurrent.Callable;
+
+import javax.inject.Inject;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.MediaType;
+
+import org.apache.isis.applib.services.swagger.SwaggerService;
+import org.apache.isis.core.metamodel.services.ServicesInjectorSpi;
+import org.apache.isis.core.runtime.system.context.IsisContext;
+import org.apache.isis.core.runtime.system.persistence.PersistenceSession;
+
+@Path("/swagger")
+public class SwaggerSpecResource {
+
+ @Context
+ HttpHeaders httpHeaders;
+
+ @Path("/private")
+ @GET
+ @Consumes({ MediaType.WILDCARD, MediaType.APPLICATION_JSON, "text/yaml" })
+ @Produces({
+ MediaType.APPLICATION_JSON, "text/yaml"
+ })
+ public String swaggerPrivate() {
+ return swagger(SwaggerService.Visibility.PRIVATE);
+ }
+
+ @Path("/prototyping")
+ @GET
+ @Consumes({ MediaType.WILDCARD, MediaType.APPLICATION_JSON, "text/yaml" })
+ @Produces({
+ MediaType.APPLICATION_JSON, "text/yaml"
+ })
+ public String swaggerPrototyping() {
+ return swagger(SwaggerService.Visibility.PRIVATE_WITH_PROTOTYPING);
+ }
+
+ @Path("/public")
+ @GET
+ @Consumes({ MediaType.WILDCARD, MediaType.APPLICATION_JSON, "text/yaml" })
+ @Produces({
+ MediaType.APPLICATION_JSON, "text/yaml"
+ })
+ public String swaggerPublic() {
+ return swagger(SwaggerService.Visibility.PUBLIC);
+ }
+
+ private String swagger(final SwaggerService.Visibility visibility) {
+ final SwaggerService.Format format = deriveFrom(httpHeaders);
+ String spec = IsisContext.doInSession(new MyCallable(visibility, format));
+ return spec;
+ }
+
+ private SwaggerService.Format deriveFrom(final HttpHeaders httpHeaders) {
+ final List<MediaType> acceptableMediaTypes = httpHeaders.getAcceptableMediaTypes();
+ for (MediaType acceptableMediaType : acceptableMediaTypes) {
+ if(acceptableMediaType.isCompatible(MediaType.APPLICATION_JSON_TYPE)) {
+ return SwaggerService.Format.JSON;
+ }
+ }
+ final MediaType applYaml = new MediaType("application", "yaml");
+ final MediaType textYaml = new MediaType("text", "yaml");
+ for (MediaType acceptableMediaType : acceptableMediaTypes) {
+ if (acceptableMediaType.isCompatible(applYaml) ||
+ acceptableMediaType.isCompatible(textYaml)) {
+ return SwaggerService.Format.YAML;
+ }
+ }
+ return SwaggerService.Format.JSON;
+ }
+
+ static class MyCallable implements Callable<String> {
+
+ private final SwaggerService.Visibility visibility;
+ private final SwaggerService.Format format;
+
+ public MyCallable(
+ final SwaggerService.Visibility visibility,
+ final SwaggerService.Format format) {
+ this.visibility = visibility;
+ this.format = format;
+ }
+
+ @Override
+ public String call() throws Exception {
+ getServicesInjector().injectServicesInto(this);
+ return swaggerService.generateSwaggerSpec(visibility, format);
+ }
+
+ @Inject
+ SwaggerService swaggerService;
+
+ ServicesInjectorSpi getServicesInjector() {
+ return getPersistenceSession().getServicesInjector();
+ }
+
+ PersistenceSession getPersistenceSession() {
+ return IsisContext.getPersistenceSession();
+ }
+ }
+}
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/example/application/simpleapp/webapp/pom.xml
----------------------------------------------------------------------
diff --git a/example/application/simpleapp/webapp/pom.xml b/example/application/simpleapp/webapp/pom.xml
index e81c6a5..eeb2285 100644
--- a/example/application/simpleapp/webapp/pom.xml
+++ b/example/application/simpleapp/webapp/pom.xml
@@ -323,5 +323,4 @@
</profile>
</profiles>
-
</project>
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/example/application/simpleapp/webapp/src/main/webapp/WEB-INF/web.xml
----------------------------------------------------------------------
diff --git a/example/application/simpleapp/webapp/src/main/webapp/WEB-INF/web.xml b/example/application/simpleapp/webapp/src/main/webapp/WEB-INF/web.xml
index 1ef1f47..ac9d154 100644
--- a/example/application/simpleapp/webapp/src/main/webapp/WEB-INF/web.xml
+++ b/example/application/simpleapp/webapp/src/main/webapp/WEB-INF/web.xml
@@ -165,7 +165,22 @@
<servlet-name>Resource</servlet-name>
<url-pattern>*.swf</url-pattern>
</servlet-mapping>
-
+
+
+ <servlet>
+ <servlet-name>WebjarsServlet</servlet-name>
+ <servlet-class>org.webjars.servlet.WebjarsServlet</servlet-class>
+ <init-param>
+ <param-name>disableCache</param-name>
+ <param-value>true</param-value>
+ </init-param>
+ <load-on-startup>2</load-on-startup>
+ </servlet>
+ <servlet-mapping>
+ <servlet-name>WebjarsServlet</servlet-name>
+ <url-pattern>/webjars/*</url-pattern>
+ </servlet-mapping>
+
<!--
http://git-wip-us.apache.org/repos/asf/isis/blob/86b960ac/example/application/simpleapp/webapp/src/main/webapp/api-docs/index.html
----------------------------------------------------------------------
diff --git a/example/application/simpleapp/webapp/src/main/webapp/api-docs/index.html b/example/application/simpleapp/webapp/src/main/webapp/api-docs/index.html
new file mode 100644
index 0000000..bc9415a
--- /dev/null
+++ b/example/application/simpleapp/webapp/src/main/webapp/api-docs/index.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html>
+<head>
+ <meta charset="UTF-8">
+ <base href="../webjars/swagger-ui/2.1.3/"/>
+ <title>Swagger UI</title>
+ <link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />
+ <link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />
+ <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+ <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+ <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+ <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+ <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
+ <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+ <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
+ <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
+ <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+ <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>
+ <script src='lib/underscore-min.js' type='text/javascript'></script>
+ <script src='lib/backbone-min.js' type='text/javascript'></script>
+ <script src='swagger-ui.js' type='text/javascript'></script>
+ <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>
+ <script src='lib/marked.js' type='text/javascript'></script>
+ <script src='lib/swagger-oauth.js' type='text/javascript'></script>
+
+ <!-- Some basic translations -->
+ <!-- <script src='lang/translator.js' type='text/javascript'></script> -->
+ <!-- <script src='lang/ru.js' type='text/javascript'></script> -->
+ <!-- <script src='lang/en.js' type='text/javascript'></script> -->
+
+ <script type="text/javascript">
+ $(function () {
+ var url = window.location.search.match(/url=([^&]+)/);
+ if (url && url.length > 1) {
+ url = decodeURIComponent(url[1]);
+ } else {
+ url = "/restful/swagger/private"
+ }
+
+ // Pre load translate...
+ if(window.SwaggerTranslator) {
+ window.SwaggerTranslator.translate();
+ }
+ window.swaggerUi = new SwaggerUi({
+ url: url,
+ dom_id: "swagger-ui-container",
+ supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+ onComplete: function(swaggerApi, swaggerUi){
+ if(typeof initOAuth == "function") {
+ initOAuth({
+ clientId: "your-client-id",
+ clientSecret: "your-client-secret-if-required",
+ realm: "your-realms",
+ appName: "your-app-name",
+ scopeSeparator: ","
+ });
+ }
+
+ if(window.SwaggerTranslator) {
+ window.SwaggerTranslator.translate();
+ }
+
+ $('pre code').each(function(i, e) {
+ hljs.highlightBlock(e)
+ });
+
+ addApiKeyAuthorization();
+ },
+ onFailure: function(data) {
+ log("Unable to Load SwaggerUI");
+ },
+ docExpansion: "none",
+ apisSorter: "alpha",
+ defaultModelRendering: 'schema',
+ showRequestHeaders: false
+ });
+
+ function addApiKeyAuthorization(){
+ var key = encodeURIComponent($('#input_apiKey')[0].value);
+ if(key && key.trim() != "") {
+ var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
+ window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
+ log("added key " + key);
+ }
+ }
+
+ $('#input_apiKey').change(addApiKeyAuthorization);
+
+ // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...
+ /*
+ var apiKey = "myApiKeyXXXX123456789";
+ $('#input_apiKey').val(apiKey);
+ */
+
+ window.swaggerUi.load();
+
+ function log() {
+ if ('console' in window) {
+ console.log.apply(console, arguments);
+ }
+ }
+ });
+ </script>
+</head>
+
+<body class="swagger-section">
+<div id='header'>
+ <div class="swagger-ui-wrap">
+ <a id="logo" href="http://swagger.io">swagger</a>
+ <form id='api_selector'>
+ <div class='input'>
+ <!--
+ <select name="foo">
+ <option id="public" label="public" value="/restful/swagger/public"/>
+ <option id="private" label="private" value="/restful/swagger/private"/>
+ <option id="prototyping" label="prototyping" value="/restful/swagger/prototyping"/>
+ </select>
+ -->
+ <input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text">
+ </div>
+ <div class='input' style="display:none;"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
+ <div class='input'><a id="explore" href="#" data-sw-translate>Explore</a></div>
+ </form>
+ </div>
+</div>
+
+<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>
+<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
+</body>
+</html>
\ No newline at end of file