From 7f21bebeda922c026454ffdcfef30d7c00af916d Mon Sep 17 00:00:00 2001 From: SrGooglo Date: Wed, 26 Mar 2025 14:58:20 +0000 Subject: [PATCH] update server docs --- docs/server/create-http-server-example.md | 104 +++++++++++++++++++++ server/README.md | 105 +--------------------- 2 files changed, 108 insertions(+), 101 deletions(-) create mode 100644 docs/server/create-http-server-example.md diff --git a/docs/server/create-http-server-example.md b/docs/server/create-http-server-example.md new file mode 100644 index 0000000..6d00cb8 --- /dev/null +++ b/docs/server/create-http-server-example.md @@ -0,0 +1,104 @@ +### Example +Create a http server +```js +// index.js +import { Server } from "linebridge" + +class MyAPI extends Server { + // set a id for the server + static refName = "my-api" + // define a file based router + static routesPath = `${__dirname}/routes` + // define custom listen port + static listenPort = 3000 + + // set manual routes + routes = { + // basic route + "/hi": { + method: "get", + fn: async (req, res) => { + return { + message: "Hello world" + } + } + }, + // use custom middleware + "/middleware-custom": { + method: "get", + middlewares: [ + "custom-middleware" + ], + fn: async (req, res) => { + return { + message: "The middleware is working!" + } + } + }, + // get from context + "/db": { + method: "get", + useContexts: [ + "db" + ], + fn: async (req, res, ctx) => { + console.log(ctx) + return ctx.db.data + } + }, + // use parameters + "/sum/:value1/:value2": { + method: "get", + fn: async (req, res) => { + return { + result: parseInt(req.params.value1) + parseInt(req.params.value2) + } + } + } + } + + // define default middlewares to use on every request + useMiddlewares = [ + async (req, res) => { + console.log("Im executed every request") + } + ] + + // you can also define custom middlewares to use on endpoints + middlewares = { + "custom-middleware": async (req, res) => { + console.log("Im a custom middleware") + } + } + + // define custom contexts to use on endpoints + contexts = { + db: { + data: [ + { + id: 1, + name: "John Doe" + }, + { + id: 2, + name: "Jane Doe" + } + ] + } + } + + async onInitialize() { + console.log("Server initialized") + } + + async onClose() { + console.log("Server closed") + } +} + +Boot(MyAPI) +``` +Run the server +```bash +linebridge-boot index.js +``` diff --git a/server/README.md b/server/README.md index b051181..e0ed41f 100755 --- a/server/README.md +++ b/server/README.md @@ -29,107 +29,10 @@ npm install linebridge > [!WARNING] > If you're using Yarn, you might encounter installation issues. We recommend using npm. -### Example -Create a http server -```js -// index.js -import { Server } from "linebridge" - -class MyAPI extends Server { - // set a id for the server - static refName = "my-api" - // define a file based router - static routesPath = `${__dirname}/routes` - // define custom listen port - static listenPort = 3000 - - // set manual routes - routes = { - // basic route - "/hi": { - method: "get", - fn: async (req, res) => { - return { - message: "Hello world" - } - } - }, - // use custom middleware - "/middleware-custom": { - method: "get", - middlewares: [ - "custom-middleware" - ], - fn: async (req, res) => { - return { - message: "The middleware is working!" - } - } - }, - // get from context - "/db": { - method: "get", - useContexts: [ - "db" - ], - fn: async (req, res, ctx) => { - console.log(ctx) - return ctx.db.data - } - }, - // use parameters - "/sum/:value1/:value2": { - method: "get", - fn: async (req, res) => { - return { - result: parseInt(req.params.value1) + parseInt(req.params.value2) - } - } - } - } - - // define default middlewares to use on every request - useMiddlewares = [ - async (req, res) => { - console.log("Im executed every request") - } - ] - - // you can also define custom middlewares to use on endpoints - middlewares = { - "custom-middleware": async (req, res) => { - console.log("Im a custom middleware") - } - } - - // define custom contexts to use on endpoints - contexts = { - db: { - data: [ - { - id: 1, - name: "John Doe" - }, - { - id: 2, - name: "Jane Doe" - } - ] - } - } - - async onInitialize() { - console.log("Server initialized") - } - - async onClose() { - console.log("Server closed") - } -} - -Boot(MyAPI) -``` -Run the server +### Boot the server ```bash linebridge-boot index.js ``` + +### Examples & docs +[create-http-server-example](../docs/server/create-http-server-example.md)