Giter Club home page Giter Club logo

phoenix_route_documenter's Introduction

Phoenix Route Documenter

This hex package will return a map of your Phoenix application's routes similar to the following:

%{
  paths: [
    %{
      method: "GET",
      path: "/path/to/thing/"
    },
    %{
      method: "GET",
      path: "/path/to/thing/:id"
    },
    %{
      method: "POST",
      path: "/path/to/thing/"
    },
    %{
      method: "PUT",
      path: "/path/to/thing/:id"
    },
  ]
}

This is particularly useful if you want to have an endpoint for your api that documents all of your endpoints for you automatically.

defmodule YourApp.RoutesController do
  use YourApp.Web, :controller

  alias YourApp.Router
  alias PhoenixRouteDocumenter.Endpoints

  def index(conn, _params) do
    endpoints = Endpoints.listing(Router)

    conn
    |> json(endpoints)
  end
end

Installation

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

def deps do
  [{:phoenix_route_documenter, "~> 0.1.0"}]
end

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.