Giter Club home page Giter Club logo

ukforeignoffice.json-schema-simplifier's Introduction

JSON schema simplifier Maven plugin

A simple Maven plugin to generate simplified JSON schema from any standard JSON schema (tested up to draft 7).

The simplification process:

  • Removes non-standard properties (e.g. javaType);
  • Resolves references to other files/definitions, so that each output JSON schema file is standalone.

This is useful where you need to reuse your JSON schemae in applications which require simpler implementations, e.g. configuring models in AWS API Gateway or referencing from n OpenAPI3 interface specification.

Usage:

Currently, this tool is only set up to be used as a Maven plugin. Add this to the build/plugins section of your pom file:

<plugin>
    <groupId>com.kestreldigital</groupId>
    <artifactId>json-schema-simplifier-maven-plugin</artifactId>
    <version>0.0.1</version>
    <configuration>
        <sourceDirectory>${basedir}/json-schema</sourceDirectory>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>simplify</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Configuration:

  • sourceDirectory: Path of the folder containing your JSON schema files (required).

ukforeignoffice.json-schema-simplifier's People

Contributors

sgawith avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.