Code Monkey home page Code Monkey logo

muesli-schema's Introduction

Muesli Schema

Greenkeeper badge Build Status

Json-schema is full of sugar. Let's restrict it to the essentials and have a great day.

This subset is designed specifically to be easily converted to Typescript and other static-type systems.

Details:

In contrast to normal json-schema, the root must be an object type and contain a title. All object types are strict in the sense that all properties must be explicitly specified. This is achieved by enforcing additionalProperties to be specified as false. Additionally the required array must be specified, even if it is empty.

The following is a valid muesli schema specified as JavaScript.

{
  title: 'Person',
  type: 'object',
  properties: {
    id: { type: 'string' },
    first_name: { type: 'string' },
    last_name: { type: 'string' },
    address: {
      type: 'object',
      properties: {
        street: { type: 'string' },
        city: { type: 'string' },
      },
      required: ['city'],
      additionalProperties: false,
    },
  },
  required: ['id'],
  additionalProperties: false,
}

Todo:

  • Validate test cases against muesli schema
  • Setup test suite against TypeScript interfaces
  • Implement Muesli-schema to TypeScript interface

Muesli Swagger Server

Tooling for creating TypeScript servers from a subset of the Swagger spec.

Muesli Swagger Client

Tooling for creating TypeScript cleints from a subset of the Swagger spec.

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.