Git Product home page Git Product logo

elixir-restclient's Introduction

RestClient

RestClient is a generic REST client library. It generates structs and functions for use with APIs. I currently use it for interfacing the Paymill API from Elixir.

Setup

Add RestClient and ibrowse as dependencies in your mix.exs:

defp deps do
  [
    {:rest_client, "~> 0.0.1"},
    {:ibrowse, github: "cmullaparthi/ibrowse", tag: "v4.1.2"}
  ]
end

Add RestClient as application in your mix.exs:

def application do
  [applications: [:logger, :rest_client]]
end

Example Usage

defmodule Test do
    api "http://test.com"
end

def Test.User do
  resource Test, [:id, :username, :email]
end

This will give you the following functions:

  • Test.User.index/1
  • Test.User.update/3
  • Test.User.show/2
  • Test.User.create/2
  • Test.User.delete/2

The first parameter is used to pass in authentication (currently we assume http basic authentication), e.g. Test.index {"myuser", "mypass"}

elixir-restclient's People

Contributors

phikes avatar

Watchers

 avatar  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.