Commit 79d78525 authored by Noel Alonso's avatar Noel Alonso
Browse files

Actualiza imagen de compilación

parents 1fad3129 b0a76e55

.gitignore

+3 −1
Original line number Diff line number Diff line
@@ -2,4 +2,6 @@ 
target

*.iml

.idea

.classpath

.project

.settings

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ stages: 


maven-build:

  stage: build

  image: redmic/maven-gitlab

  image: registry.gitlab.com/redmic-project/docker/maven

  variables:

    MAVEN_OPTS: "-Dmaven.repo.local=.m2/repository"

  only:

README.md

+4 −166
Original line number Diff line number Diff line 
Jackson jsonSchema Generator

===================================

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.kjetland/mbknor-jackson-jsonschema_2.12/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Cmbknor-jackson-jsonSchema)



This projects aims to do a better job than the original [jackson-module-jsonSchema](https://github.com/FasterXML/jackson-module-jsonSchema)

in generating jsonSchema from your POJOs using Jackson @Annotations.

|    Metrics    |                                                                                     Master                                                                                     |                                                                                  Develop                                                                                 |

|:-------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

| CI status     | [![pipeline status](https://gitlab.com/redmic-project/third-party/jsonschema-generator/badges/master/pipeline.svg)](https://gitlab.com/redmic-project/third-party/jsonschema-generator/commits/master) | [![pipeline status](https://gitlab.com/redmic-project/third-party/jsonschema-generator/badges/dev/pipeline.svg)](https://gitlab.com/redmic-project/third-party/jsonschema-generator/commits/dev) |



Current version: *1.0.10*



**Highlights**



* JSON Schema Draft v4

* Supports polymorphism (**@JsonTypeInfo**, **MixIn**, and **registerSubtypes()**) using JsonSchema's **oneOf**-feature.

* Supports schema customization using:

  - **@JsonSchemaDescription**/**@JsonPropertyDescription**

  - **@JsonSchemaFormat**

  - **@JsonSchemaTitle**

  - **@JsonSchemaDefault**

* Supports many Javax-validation @Annotations

* Works well with Generated GUI's using [https://github.com/jdorn/json-editor](https://github.com/jdorn/json-editor)

  - (Must be configured to use this mode)

  - Special handling of Option-/Optional-properties using oneOf.

* Supports custom Class-to-format-Mapping

    



**Benefits**



* Simple implementation - Just [one file](https://github.com/mbknor/mbknor-jackson-jsonSchema/blob/master/src/main/scala/com/kjetland/jackson/jsonSchema/JsonSchemaGenerator.scala)  (for now..) 

* Implemented in Scala (*Built for 2.10, 2.11 and 2.12*)

* Easy to fix and add functionality





Project status

---------------

We're currently using this codebase in an ongoing (not yet released) project at work,

and we're improving the jsonSchema-generating code when we finds issues and/or features we need that not yet is supported.



I would really appreciate it if other developers wanted to start using and contributing improvements and features. 



Dependency

===================



This project publishes artifacts to central maven repo.



The project is also compiled using Java 8. This means that you also need to use Java 8.



Artifacts for both Scala 2.10, 2.11 and 2.12 is now available (Thanks to [@bbyk](https://github.com/bbyk) for adding crossBuild functionality). 



Using Maven

-----------------

 

Add this to you pom.xml:



    <dependency>

        <groupId>com.kjetland</groupId>

        <artifactId>mbknor-jackson-jsonschema_2.12</artifactId>

        <version>1.0.10</version>

    </dependency>    



Using sbt

------------

 

Add this to you sbt build-config:



    "com.kjetland" % "mbknor-jackson-jsonschema" %% "1.0.10"





Code - Using Scala

-------------------------------



This is how to generate jsonSchema in code using Scala:



```scala

    val objectMapper = new ObjectMapper

    val jsonSchemaGenerator = new JsonSchemaGenerator(objectMapper)

    val jsonSchema:JsonNode = jsonSchemaGenerator.generateJsonSchema(classOf[YourPOJO])

    

    val jsonSchemaAsString:String = objectMapper.writeValueAsString(jsonSchema)

```



This is how to generate jsonSchema used for generating HTML5 GUI using [json-editor](https://github.com/jdorn/json-editor): 



```scala

    val objectMapper = new ObjectMapper

    val jsonSchemaGenerator = new JsonSchemaGenerator(objectMapper, config = JsonSchemaConfig.html5EnabledSchema)

    val jsonSchema:JsonNode = jsonSchemaGenerator.generateJsonSchema(classOf[YourPOJO])

    

    val jsonSchemaAsString:String = objectMapper.writeValueAsString(jsonSchema)

```



This is how to generate jsonSchema using custom type-to-format-mapping using Scala:



```scala

    val objectMapper = new ObjectMapper

    val config:JsonSchemaConfig = JsonSchemaConfig.vanillaJsonSchemaDraft4.copy(

      customType2FormatMapping = Map( "java.time.OffsetDateTime" -> "date-time-ABC-Special" )

    )

    val jsonSchemaGenerator = new JsonSchemaGenerator(objectMapper, config = config)

    val jsonSchema:JsonNode = jsonSchemaGenerator.generateJsonSchema(classOf[YourPOJO])

    

    val jsonSchemaAsString:String = objectMapper.writeValueAsString(jsonSchema)

```



**Note about Scala and Option[Int]**:



Due to Java's Type Erasure it impossible to resolve the type T behind Option[T] when T is Int, Boolean, Double.

Ass a workaround, you have to use the *@JsonDeserialize*-annotation in such cases.

See https://github.com/FasterXML/jackson-module-scala/wiki/FAQ#deserializing-optionint-and-other-primitive-challenges for more info.



Example:

```scala

    case class PojoUsingOptionScala(

                                     _string:Option[String], // @JsonDeserialize not needed here

                                     @JsonDeserialize(contentAs = classOf[Int])     _integer:Option[Int],

                                     @JsonDeserialize(contentAs = classOf[Boolean]) _boolean:Option[Boolean],

                                     @JsonDeserialize(contentAs = classOf[Double])  _double:Option[Double],

                                     child1:Option[SomeOtherPojo] // @JsonDeserialize not needed here

                                   )

```



PS: Scala Option combined with Polymorphism does not work in jackson-scala-module and therefor not this project either.



Code - Using Java

-------------------------



```java

    ObjectMapper objectMapper = new ObjectMapper();

    JsonSchemaGenerator jsonSchemaGenerator = new JsonSchemaGenerator(objectMapper);

    

    // If using JsonSchema to generate HTML5 GUI:

    // JsonSchemaGenerator html5 = new JsonSchemaGenerator(objectMapper, JsonSchemaConfig.html5EnabledSchema() );

    

    // If you want to confioure it manually:

    // JsonSchemaConfig config = JsonSchemaConfig.create(...);

    // JsonSchemaGenerator generator = new JsonSchemaGenerator(objectMapper, config);

               

    

    JsonNode jsonSchema = jsonSchemaGenerator.generateJsonSchema(YourPOJO.class);

    

    String jsonSchemaAsString = objectMapper.writeValueAsString(jsonSchema);

```



Backstory

--------------





At work we've been using the original [jackson-module-jsonSchema](https://github.com/FasterXML/jackson-module-jsonSchema) 

to generate schemas used when rendering dynamic GUI using [https://github.com/jdorn/json-editor](https://github.com/jdorn/json-editor).



Recently we needed to support POJO's using polymorphism like this:



```java

    @JsonTypeInfo(

            use = JsonTypeInfo.Id.NAME,

            include = JsonTypeInfo.As.PROPERTY,

            property = "type")

    @JsonSubTypes({

            @JsonSubTypes.Type(value = Child1.class, name = "child1"),

            @JsonSubTypes.Type(value = Child2.class, name = "child2") })

    public abstract class Parent {

    

        public String parentString;

        

    }

```

    

This is not supported by the original [jackson-module-jsonSchema](https://github.com/FasterXML/jackson-module-jsonSchema).

I have spent many hours trying to figure out how to modify/improve it without any luck,

and since it is implemented in such a complicated way, I decided to instead write my own

jsonSchema generator from scratch.
 
This projects aims to add new @Annotations to original [mbknor-jackson-jsonschema](https://github.com/mbknor/mbknor-jackson-jsonSchema)
 
 No newline at end of file

pom.xml

+42 −6
Original line number Diff line number Diff line 
<?xml version='1.0' encoding='UTF-8'?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	

	<parent>

		<groupId>es.redmic.lib</groupId>

		<artifactId>libs</artifactId>

		<version>0.6.0</version>

		<groupId>org.springframework.boot</groupId>

		<artifactId>spring-boot-starter-parent</artifactId>

		<version>2.0.0.RELEASE</version>

		<relativePath />

	</parent>

	

	<modelVersion>4.0.0</modelVersion>

	<groupId>es.redmic.lib</groupId>

	<artifactId>jackson-jsonschema</artifactId>

	<packaging>jar</packaging>

	<version>0.6.0</version>

	<name>Jackson JsonSchema</name>

	<description>JsonSchema</description>

	<description>JsonSchema generator</description>

	

	<properties>

		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

		<maven.compiler.source>1.8</maven.compiler.source>

		<maven.compiler.target>1.8</maven.compiler.target>

		<java.version>1.8</java.version>



		<!-- OTHERS -->

		<scala-library.version>2.11.8</scala-library.version>

		

		<!-- PLUGINS -->

		<maven-scala-plugin.version>2.15.2</maven-scala-plugin.version>

		

		<!-- Environment variables -->

		<env.MAVEN_REPO_URL>https://artifactory.redmic.net/artifactory</env.MAVEN_REPO_URL>

	</properties>

	

	<dependencies>

		<dependency>

			<groupId>org.scala-lang</groupId>

			<artifactId>scala-library</artifactId>

			<version>2.11.8</version>

			<version>${scala-library.version}</version>

		</dependency>

		<dependency>

			<groupId>com.fasterxml.jackson.core</groupId>
@@ -29,12 +52,25 @@ 
			<artifactId>slf4j-api</artifactId>

		</dependency>

	</dependencies>

	<distributionManagement>

		<repository>

			<id>central</id>

			<name>redmic-releases</name>

			<url>${env.MAVEN_REPO_URL}/libs-release-local</url>

		</repository>

		<snapshotRepository>

			<id>snapshots</id>

			<name>redmic-snapshots</name>

			<url>${env.MAVEN_REPO_URL}/libs-snapshot-local</url>

			<uniqueVersion>false</uniqueVersion>

		</snapshotRepository>

	</distributionManagement>

	<build>

		<plugins>

			<plugin>

				<groupId>org.scala-tools</groupId>

				<artifactId>maven-scala-plugin</artifactId>

				<version>2.15.2</version>

				<version>${maven-scala-plugin.version}</version>

				<executions>

					<execution>

						<goals>