ResourceID

Hex.pm Build Status Coverage Status Hex.pm

REST endpoints without PII in URLs.

Quick Setup

defmodule MyRouter do
  use Plug.Router

  plug ResourceID
  plug :match
  plug :dispatch

  get "/api/v1/users/:user/email" do
    ...
  end
end

Configuration

prefix

Prefix all headers with a set string. This limits header user to only headers that start with the set prefix.

Example:

plug ResourceID, prefix: "x-resource-"

Installation

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

def deps do
  [
    {:resource_id, "~> 1.0"}
  ]
end

The docs can be found at https://hexdocs.pm/resource_id.

Changelog

1.0.0 (2020-02-15)

Initial release.

Copyright (c) 2020, Ian Luites.

ResourceID code is licensed under the MIT License.