scrivener_headers v1.0.0 Scrivener.Headers

Helpers for paginating API responses with Scrivener and HTTP headers. Implements RFC-5988, the proposed standard for Web linking.

Use paginate/2 to set the pagination headers:

def index(conn, params) do
  page = MyApp.Person
         |> where([p], p.age > 30)
         |> order_by([p], desc: p.age)
         |> preload(:friends)
         |> MyApp.Repo.paginate(params)

  conn
  |> Scrivener.Headers.paginate(page)
  |> render("index.json", people: page.entries)
end

Summary

Functions

Add HTTP headers for a Scrivener.Page

Functions

paginate(conn, page)

Specs

paginate(Plug.Conn.t, Scrivener.Page.t) :: Plug.Conn.t

Add HTTP headers for a Scrivener.Page.