typescript-express-basic

Welcome to typescript-express-basic 👋

Basic api concept using typescript for express.

https://www.npmjs.com/package/typescript-express-basic

🏠 Homepage

Concept

Install

Install express from https://expressjs.com/

npm install express --save

Install extend express basic

npm install typescript-express-basic --save

Optionals:

Swagger UI

Compatable with https://brikev.github.io/express-jsdoc-swagger-docs/#/README, included in the 'test' folder

https://brikev.github.io/express-jsdoc-swagger-docs/#/README

Creating example controller

Example file: https://github.com/vosonha89/typescript-express-basic/blob/main/test/src/controllers/publicController.ts

export class PublicController extends ApiController {
    public controllerName = 'public';

    @ApiRoute({
        method: ApiMethod.GET,
        path: '/get'
    })
    public get(req: Request, res: Response): void {
        const id = req.query.id;
        res.status(StatusCode.Ok);
        res.send('Public get ' + id);
    }
}

Register app & controllers

Example file: https://github.com/vosonha89/typescript-express-basic/blob/main/test/src/index.ts

const port = 3000;
let app = apiExpress;
app.use(express.json());

// Register controller
app.registerController(new PublicController());

app.listen(port, () => {
    console.log(`[server]: Server is running at http://localhost:${port}`);
});

Run test project

npm run test

Link: http://localhost:3000

Author

👤 vosonha89

• Github: @vosonha89
• LinkedIn: @https://www.linkedin.com/in/vo-son-ha/

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2024 vosonha89.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator