Giter Club home page Giter Club logo

substrate's Introduction

Substrate

Build Status Docs Status

Substrate combines Open API Spex and decentralized routing definitions for REST services. This package is heavily inspired by Flask-Rebar.

Features

  • Automatic OpenAPI generation via Open API Spex.
  • Request, response, and query param validation via Open API Spex.
  • Decentralized routing definitions move route definitions out of the Phoenix router and into your controllers, alongside the rest of the endpoint's OpenAPI specifications.

Example

# lib/your_app_web/registry.ex

defmodule YourAppWeb.Registry do
  use Substrate.Registry, prefix: "/api"
end


# lib/your_app_web/router.ex

defmodule YourAppWeb.Router do
  use Phoenix.Router
  require Substrate

  Substrate.collect_all do
    entry(YourAppWeb.UserController, :list_users)
    entry(YourAppWeb.UserController, :get_users)
  end
end


# lib/your_app_web/controllers/users_controller.ex

defmodule YourAppWeb.UserListController do
  use Phoenix.Controller
  use YourAppWeb.Registry,
    path: "/users",
    pethod: :get

  def list_users(conn, _path_args_, _validated_params_, _request_body) do
    conn
    |> json(%{
      data: [%{name: "John McPhee"}]
    })
  end
end

Installation

The package can be installed by adding substrate to your list of dependencies in mix.exs:

def deps do
  [
    {:substrate, "~> 0.1"}
  ]
end

substrate's People

Stargazers

 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.