n4u
/
rest


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
							<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="" />
<meta name="author" content="Maxim Sokhatsky" />
<title>REST</title>
<link rel="stylesheet" href="https://synrc.space/synrc.css" />
</head>
<body>
<nav>
    <a href="https://n2o.dev">DEV</a>
    <a href="#" style="background:#ededed;">REST</a>
    <a href="https://n2o.dev/deps/rest/man/ua/index.html">UA</a>
    <a href="#" style="background:#ededed;">EN</a>
</nav>
<header>
    <a href="https://github.com/synrc/rest"><img src="https://synrc.space/images/Synrc Neo.svg?v=1" /></a>
    <h1>REST</h1>
</header>
<aside>
    <article>
        <section>
            <h3>SYNOPSIS</h3>
            <div>REST: framework with typed JSON<br /><br />
                 <b>Features and Goals</b><br /><br />
                 1. Fastest possible Record &#60;-&#62; Proplists transformations<br />
                 2. Smallest REST framework in the world<br />
                 3. ETS/KVS/Any storage selection by scaffolding<br /><br />
                 We&#39;ve achived first goal by providing parse_transform code generation for tuple transformations.
                 And second requirement was achieved by not including routing bullshit and other uncertain features.
            </div>
        </section>

        <section>
            <a name="usage"></a><h3>USAGE</h3>
            <div>Just plug REST endpoint directly to your Cowboy router:</div>
        <figure>
        <code>
  {"/rest/:resource", rest_cowboy, []},
  {"/rest/:resource/:id", rest_cowboy, []},
        </code>
        </figure>
            <div>
                OCT 2018 © <a href="https://github.com/5HT">5HT</a> <a href="https://5ht.co/license.htm">ISC</a><br />
                VER 5.10
            </div>
        </section>
    </article>
</aside>
<main>
    <section>
        <a name="module"></a><h3>Module</h3>
        <p>
            Sample REST service implementation:
        </p>
        <figure>
        <code>
-module(users).
-behaviour(rest).
-compile({parse_transform, rest}).
-include("users.hrl").
-export([init/0, populate/1, exists/1, get/0, get/1, post/1, delete/1]).
-rest_record(user).

init() -> ets:new(users, [public, named_table, {keypos, #user.id}]).
populate(Users) -> ets:insert(users, Users).
exists(Id) -> ets:member(users, wf:to_list(Id)).
get() -> ets:tab2list(users).
get(Id) -> [User] = ets:lookup(users, wf:to_list(Id)), User.
delete(Id) -> ets:delete(users, wf:to_list(Id)).
post(#user{} = User) -> ets:insert(users, User);
post(Data) -> post(from_json(Data, #user{})).
        </code>
        </figure>
    </section>
    <section>
        <a name="usage2"></a><h3>Usage</h3>
        <figure>
        <code>
$ curl -i -X POST -d "id=vlad" localhost:8005/rest/users
$ curl -i -X POST -d "id=doxtop" localhost:8005/rest/users
$ curl -i -X GET localhost:8005/rest/users
$ curl -i -X PUT -d "id=5HT" localhost:8005/rest/users/vlad
$ curl -i -X GET localhost:8005/rest/users/5HT
$ curl -i -X DELETE localhost:8005/rest/users/5HT
        </code></figure>
    </section>

    <section>
        <a name="modules"></a><h3>Modules</h3>
        <ul><li><b><a href="man/rest.htm">rest</a></b> — rest</li>
            <li><b><a href="man/rest_app.htm">rest_app</a></b> — rest_app</li>
            <li><b><a href="man/rest_cowboy.htm">rest_cowboy</a></b> — rest_cowboy</li>
            <li><b><a href="man/rest_sup.htm">rest_sup</a></b> — rest_sup</li>
        </ul>
    </section>

    <section>
        <a name="credits"></a><h3>Credits</h3>
        <ul><li>Dmitry Bushmelev</li></ul>
    </section>
</main>
<footer>
    Made with <span class="heart">❤</span> to Erlang
</footer>
</body>
</html>