docs

Leptus documentation

Leptus documentation

Overview

-module(hello).
-compile({parse_transform, leptus_pt}).

%% leptus callbacks
-export([init/3]).
-export([get/3]).
-export([terminate/4]).

init(_Route, _Req, State) ->
    {ok, State}.

get("/", _Req, State) ->
    {<<"Hello, leptus!">>, State};
get("/hi/:name", Req, State) ->
    Status = ok,
    Name = leptus_req:param(Req, name),
    Body = [{<<"say">>, <<"Hi">>}, {<<"to">>, Name}],
    {Status, {json, Body}, State}.

terminate(_Reason, _Route, _Req, _State) ->
    ok.

Note the use of the following in your request/resource handler module.

-compile({parse_transform, leptus_pt}).

Let’s compile and run the example above.

$ erl -pa ebin deps/*/ebin

> c(hello).
> leptus:start_listener(http, [{'_', [{hello, undefined_state}]}]).
Leptus started on http://127.0.0.1:8080

$ curl localhost:8080/hi/Leptus
{"say":"Hi","to":"Leptus"}

Table of contents

• Types
• Callbacks
  • prefix/0
  • init/3
  • cross_domains/3
  • is_authenticated/3
  • has_permission/3
  • HttpMethod/3
  • terminate/4
• Request
  • param/2
  • params/1
  • qs/1
  • qs_val/2
  • uri/1
  • version/1
  • method/1
  • body/1
  • body_raw/1
  • body_qs/1
  • header/2
  • parse_header/2
  • auth/2
• Configuration
  • handlers
  • options
• Start
  • leptus:start_listener/2
  • leptus:start_listener/3
  • The OTP way
• Modules
  • leptus
  • leptus_config
  • leptus_json
  • leptus_logger
  • leptus_req
  • leptus_router
  • leptus_utils