Quick setup
The page describes a quick and basic usage of @marblejs/http module.
The very basic configuration consists of two steps: HTTP listener definition and HTTP server configuration.
Since version 4.0 all HTTP-related API's are moved and organized in a dedicated
@marblejs/http package. httpListener is the basic starting point of every Marble application. It includes definitions of all global middlewares and API effects.http.listener.ts
import { httpListener } from '@marblejs/http';
import { logger$ } from '@marblejs/middleware-logger';
import { bodyParser$ } from '@marblejs/middleware-body';
import { api$ } from './api.effects';
const middlewares = [
logger$(),
bodyParser$(),
// middleware3$
// middleware4$
// ...
];
const effects = [
api$,
// endpoint2$
// endpoint3$
// ...
];
export const listener = httpListener({
middlewares,
effects,
});
And here is our simple "hello world" endpoint.
api.effects.ts
import { r } from '@marblejs/http';
import { mapTo } from 'rxjs/operators';
export const api$ = r.pipe(
r.matchPath('/'),
r.matchType('GET'),
r.useEffect(req$ => req$.pipe(
mapTo({ body: 'Hello, world!' }),
)));
To create Marble app instance, we can use
createServer, which is a wrapper around Node.js server creator with much more possibilities and goods inside. When created, it won't automatically start listening to given port and hostname until you call its awaited instance.index.ts
import { createServer } from '@marblejs/http';
import { IO } from 'fp-ts/lib/IO';
import { listener } from './http.listener';
const server = createServer({
port: 1337,
hostname: '127.0.0.1',
listener,
});
const main: IO<void> = async () =>
await (await server)();
main();
To see Marble.js in action you can visit example usage of available module for a complete Marble.js app example.
We'll use TypeScript in the documentation but you can always write Marble apps in standard JavaScript (and any other language that transpiles to JavaScript).
To test run your server you can install
typescript compiler and ts-node:$ yarn add typescript ts-node
Add the following script to your
package.json file:"scripts": {
"start": "ts-node index.ts"
}
Now go ahead, create
index.ts, http.listener.ts, api.effects.ts modules in your project and run your server:$ yarn start
In the next HTTP chapter you will learn how to create basic Marble.js endpoints using Effects, how to build and compose middlewares and how to build a basic REST API routing.
Last modified 2yr ago