Code Monkey home page Code Monkey logo

swagger-elm's Introduction

Swagger Elm

Swagger elm generates types and decoders from Swagger document.

Try it out in the browser!

Note: This project is currently under active and initial development. Thus everything is not finished and there's no guarantee that anything will work as promised. However I'm happy for any testing and feedback I can get.

Installation

  1. npm install ahultgren/swagger-elm -g
  2. Optionally install elm format

Usage (unix)

Using elm-format:

cat swagger.json | swagger-to-elm | elm-format --stdin

Unformatted (no guarantee it will work):

cat swagger.json | swagger-to-elm

Contribution

Help and feedback would be gladly appreciated, but please just drop me a line (an issue) before you start, to prevent wasted effort.

Features

  • Basic decoding of all types (Integer, Float, String, Boolean, Object, Array, Null)
  • $refs
  • Enum for strings
    • Other types (if meaningful)
  • Default values for Integer, Float, String, Boolean
    • Complex types (if meaningful)
  • Sanitization of identifiers
  • Unit tests
  • Dicts (additionalProperties)
  • Recursive types and decoders
  • Encoders
  • Polymorphism (allOf and discriminator)
  • Formats? (datetime, uuid, etc)
  • Deduplication of types and fields

License

ISC

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.