REST-like framework and server for blazing fast web applications in C++11.
REST-like framework and server for blazing fast web applications in
C++11.
$ rest-cpp new blog
$ cd blog
$ rest-cpp server
Navigate your browser to http://127.0.0.1:8080 now.
On OS X Commanand Line Tools are required; on Linux gcc-4.8 or newer is
required. Not tested on other platforms.
Build library using make on root directory.
Run make install on project folder - it will build the library and
copy headers, shared library and generator to /usr/local.
After bulding the Library, go to example/todo_server and use make.
You may build your own apps from scratch, but you can just #include <rest/rest.h>
and use simplified workflow. To make it even easier, you can use rest-cpp utility
to do some work for you.
rest-cpp allows you to create and manage app.
It is installed to /usr/local/bin and requires Python in version at
least 2.5 (which probably you have already installed).
Use rest-cpp new [directory] to create new application. directory
isn’t required, app will be created in current directory if omitted.
Created are two files:
init.cpp with basic “hello world”Makefile with build commandsExisting files are skipped, to update file to new version, just remove
previous one.
Available tasks:
make server - default action, build and start servermake build - build serverAvailable options:
address=ip_or_host - address for server to bind, default: 0.0.0.0port=number - port to listen, default: 8080 (ports lower than 1024 may require superuser privileges)workers=number - number of workers, default: 4dispatcher=lc/rr - workers dispatcher algorithm - lc for LeastConnections, rr for RoundRobin, ‘uf’ for ‘Uniform’, default: lcTo use options pass them to make, i.e. make server workers=2 port=9000.
Options are complitation-time, not runtime - this means, to i.e. change
port, you must pass port to make during building process.
rest-cpp wraps make, so you can use rest-cpp build and rest-cpp server instead of
make (you can use the same options as above).
rest-cpp has builtin generators for resources and services. They work
assuming you made your app using rake-cpp new, that is you use
init.cpp file. Generators must be run in root directory of the
project.
Resources classes will be stored in resources directory, services
for services. Generators do not check if route or other symbol
already exists in init.cpp. However, they do not override service or resource class file.
You may use both snake_case and CamelCase as names, however, generators
will always use snake_case for filenames, simple service names and URIs (unless given) and
CamelCase as Service and Resource classnames.
Inline Service is simple service implemented using C++11 lambda. Use
rest-cpp generate inline PATH to generate one, where PATH is URI to
the new service.
The following code will be added to routes() in init.cpp:
r->match("PATH", [](REST::Service* service) {
throw REST::HTTP::NotImplemented();
});
Simple Service is implemented as function in init.cpp file.
Use rest-cpp generate simple NAME PATH to generate one, where NAME
is name of function implementing service and PATH is the URI.
Two things are added to init.cpp:
create_service(NAME) {
throw REST::HTTP::NotImplemented();
}
// inside routes()
r->match("PATH", NAME);
This is variation of simple service with JSON response enabled by
default. Instead of create_service, create_json_service is used.
Generates full featured Service class - use rest-cpp generate service NAME [PATH].
You may do anything you want in Service - every HTTP method is allowed.
PATH is optional, URI is matched to snakecased NAME unless given.
Service class is generated in services/NAME.cpp as follows:
#include <rest/service.h>
class NAME : public REST::Service {
void method(REST::Request::Method type) {
throw REST::HTTP::NotImplemented();
}
};
Following route is added to init.cpp:
// inside routes()
r->mount<NAME>("PATH");
Resource represents RESTable resource. HTTP methods are mapped to CRUD
actions as follows:
POST - create()GET - read()PATCH or PUT - update()DELETE - destroy()Resource is specialization of Service, you may override method() to
handle other HTTP method (if you like to break REST pattern).
Generator creates resources/NAME.cpp file:
#include <rest/resource.h>
class NAME : public REST::Resource {
void read() {
throw REST::HTTP::NotImplemented();
}
};
Resources may be singular or plural, depending on route generated.
Singular resource match exact URI, plural resource match URI with
optional splat.
Use rest-cpp generate resource NAME [PATH] to generate singular
resource. PATH is optional, URI is matched to snakecased NAME unless
given.
// inside routes()
r->resource<NAME>("PATH");
// unless PATH given
r->resource<NAME>();
Use rest-cpp generate resources NAME [PATH] to generate plular
resource. PATH is optional, URI is matched to snakecased NAME if not
given.
// inside rotues()
r->resources<NAME>("PATH");
// unless PATH given
r->resources<NAME>();
lorem ipsum
lorem ipsum
Made with love, inspired by put.poznan.pl