Code Monkey home page Code Monkey logo

absinthe's Introduction

Absinthe

GraphQL implementation for Elixir.

Build Status

Goals:

  • Complete implementation of the GraphQL Working Draft, dated April 2016.
  • An idiomatic, readable, and comfortable API for Elixir developers
  • Detailed error messages and documentation
  • A focus on robustness and production-level performance

Please see the website at http://absinthe-graphql.org.

Features

  • Parser
    • All AST types
    • Fragments and type conditions
    • Line number reporting
    • Column number reporting (Not currently available due to Leex tokenizer constraint)
  • Schema definition
    • All types (eg, Object, Input Object, Enum, Union, Interface, Scalar)
    • Circular type references
    • Support for custom scalars
    • Support for custom directives
    • Field, argument, and enum value deprecation
    • Compile-time schema validation
  • Introspection, compatible with GraphiQL
  • Query execution
    • General
    • Named fragments, inline fragments, and fragment spreads with type conditions
    • @skip and @include directives
    • Adapter mechanism to support conversion between camelCase query documents and snake_cased schema definition.
  • Client support
    • Generation of JSON and GraphQL (IDL) introspection documents for use by client frameworks

Installation

Install from Hex.pm:

def deps do
  [{:absinthe, "~> 1.1.0"}]
end

Add it to your applications configuration in mix.exs, too:

def application do
  [applications: [:absinthe]]
end

Note: Absinthe requires Elixir 1.2 or higher.

Upgrading

See CHANGELOG for upgrade steps between versions.

Documentation

Mix Tasks

Absinthe includes a number of useful Mix tasks for extracting schema metadata.

Run mix help in your project and look for tasks starting with absinthe.

Roadmap

See the Roadmap on absinthe-graphql.org.

Related Projects

See the Project List on absinthe-graphql.org.

License

BSD License

Copyright (c) CargoSense, Inc.

Parser derived from GraphQL Elixir, Copyright (c) Josh Price https://github.com/graphql-elixir/graphql-elixir

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name Facebook nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

absinthe's People

Contributors

benwilson512 avatar bruce avatar gausby avatar iurifq avatar karlin avatar maxdec avatar readmecritic avatar rubytree 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.