swaggeraem4j

Java client generated from Swagger AEM specification using Swagger Code Generator.

License	Apache License, Version 2.0
Categories	Swagger Program Interface REST Frameworks
GroupId	com.shinesolutions
ArtifactId	swaggeraem4j
Last Version	0.10.0
Release Date	Jun 20, 2018
Type	jar
Description	swaggeraem4j Java client generated from Swagger AEM specification using Swagger Code Generator.
Project URL	https://github.com/shinesolutions/swagger-aem
Source Code Management	https://github.com/shinesolutions/swagger-aem

Download swaggeraem4j

Filename	Size
swaggeraem4j-0.10.0.pom
swaggeraem4j-0.10.0.jar	123 KB
swaggeraem4j-0.10.0-tests.jar	8 KB
swaggeraem4j-0.10.0-sources.jar	35 KB
swaggeraem4j-0.10.0-javadoc.jar	165 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.shinesolutions/swaggeraem4j/ -->
<dependency>
    <groupId>com.shinesolutions</groupId>
    <artifactId>swaggeraem4j</artifactId>
    <version>0.10.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.shinesolutions/swaggeraem4j/
implementation 'com.shinesolutions:swaggeraem4j:0.10.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.shinesolutions/swaggeraem4j/
implementation ("com.shinesolutions:swaggeraem4j:0.10.0")

Apache Buildr

'com.shinesolutions:swaggeraem4j:jar:0.10.0'

Apache Ivy

<dependency org="com.shinesolutions" name="swaggeraem4j" rev="0.10.0">
  <artifact name="swaggeraem4j" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.shinesolutions', module='swaggeraem4j', version='0.10.0')
)

Scala SBT

libraryDependencies += "com.shinesolutions" % "swaggeraem4j" % "0.10.0"

Leiningen

[com.shinesolutions/swaggeraem4j "0.10.0"]

Dependencies

compile (5)

Group / Artifact	Type	Version
io.swagger : swagger-annotations	jar	1.5.15
com.squareup.okhttp : okhttp	jar	2.7.5
com.squareup.okhttp : logging-interceptor	jar	2.7.5
com.google.code.gson : gson	jar	2.8.1
org.threeten : threetenbp	jar	1.3.5

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

Swagger AEM

Swagger AEM is an OpenAPI specification for Adobe Experience Manager (AEM) API.

This specification is used to generate client libraries for Ruby, Python, node.js, and Java using Swagger Code Generator.

Learn more about Swagger AEM:

• Generated Clients
• Development
• Testing
• Frequently Asked Questions
• Versions History
• Contribution
• Presentations

Swagger AEM is part of AEM OpenCloud platform but it can be used as a stand-alone.

Generated Clients

Language	Package	Getting Started	Status
Ruby	swagger_aem	README CHANGELOG
Python	swaggeraem	README CHANGELOG
Java	swaggeraem4j	README CHANGELOG
JavaScript	Work in progress	README CHANGELOG

Development

To run build targets using swagger-codegen in your path:

make <target>

If you want to use a custom swagger-codegen-cli.jar:

SWAGGER_CODEGEN_CLI_JAR=/path/to/swagger-codegen-cli.jar make <target>

Testing

Unit tests are generated by swagger-codegen along with the client code.

Integration tests are part of Swagger AEM and require an AEM instance running on port 4502 with Shine Solutions AEM Health Check package installed.

Frequently Asked Questions

• Q: Why does each OSGI config need to be declared as a single operation in the OpenAPI spec?
  A: There are two reasons. The first one is to explicitly define which parameters are relevant for which OSGI config, which won't be clear when we have one operation for all OSGI configs with all parameters declared within that operation. The second one is to manage the usability of the generated code. A single operation will translate to a single method with all parameters supported, which is fine in generated Ruby client because it supports optional hash, but it's a problem with generated Java client because all parameters will be declared within the method signature where caller will have to pass in nulls for the parameters that aren't relevant for the OSGI config being processed, on top of the risk of hitting maximum number of 255 parameters per method (as per JVM Specification for Java SE 11).

Contribution

Since swagger-aem contains multiple languages, add a [ruby|python|javascript|java] prefix to language-specific commits, this will help with filtering full commits log.

Tagging should also be prefixed with:

• api when the release is for the OpenAPI specification, e.g. api-1.0.0
• ruby|python|javascript|java when the release is for the generated client, e.g. ruby-0.9.2, python-0.9.0

Presentations

• Beyond AEM Curl Commands at Adobe Immerse'18
• Building An AEM API Clients Ecosystem at Adobe Experience Cloud Meetup - 5th Edition

Shine Solutions Group

Empowering our enterprise and government partners with pragmatic technology solutions

Versions

Version
0.10.0 Jun 20, 2018
0.9.3 Apr 10, 2017
0.9.2 Mar 7, 2017
0.9.1 Mar 2, 2017
0.9.0 Dec 31, 2016