https://github.com/simplymichael/express-api-starter-kit
A starter kit for building REST API applications with Express.js.
https://github.com/simplymichael/express-api-starter-kit
api express kit rest rest-api setup starter
Last synced: 3 months ago
JSON representation
A starter kit for building REST API applications with Express.js.
- Host: GitHub
- URL: https://github.com/simplymichael/express-api-starter-kit
- Owner: simplymichael
- License: mit
- Created: 2024-03-26T17:11:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-19T21:38:29.000Z (about 1 year ago)
- Last Synced: 2024-12-30T00:50:47.390Z (5 months ago)
- Topics: api, express, kit, rest, rest-api, setup, starter
- Language: JavaScript
- Homepage:
- Size: 337 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Express API Starter Kit
A starter kit for building REST API applications with Express.js.
[![Node version][node-version-image]][node-url]
[![License][license-image]][license-url]
[![Conventional commits][conventional-commits-image]][conventional-commits-url]
[![Tests][ci-image]][ci-url]
[![Coverage][codecov-image]][codecov-url]
## Routing
Routes are defined in the `src/routes` directory. Each route is an object with several properties.
One of these properties is the `handler` property which specifies the request handler for this route.
The handler can be specified in one of four ways:
- A function
- An array: `[controller: Object|String, method: Function|String]`
- An object: `{ controller: Object|String, method: Function|String }`
- A string `"controller.method"`
## Dependency Injection (DI) Container
Every route handler (both controller methods and stand-alone functions) has access
to the DI Container's methods (`register` and `resolve`) via the `this` property.
Also, every middleware and route handler can access these methods via the `req.app` property.
## Contributing
- [Report a bug][bug]
- [Request a new feature][fr]
- [Submit a pull request][pr]
- Checkout the [Contributing guide][contribute]
## License
[MIT License][license-url]
## Author
[Simplymichael](https://github.com/simplymichael) ([[email protected]](mailto:[email protected]))
[node-url]: https://nodejs.org/
[node-version-image]: https://img.shields.io/node/v/express-api-starter-kit
[license-url]: https://github.com/simplymichael/express-api-starter-kit/blob/main/LICENSE.md
[license-image]: https://img.shields.io/github/license/simplymichael/express-api-starter-kit
[conventional-commits-url]: https://conventionalcommits.org
[conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-brightgreen.svg
[ci-url]: https://github.com/simplymichael/express-api-starter-kit/actions/workflows/run-coverage-tests.yml
[ci-image]: https://github.com/simplymichael/express-api-starter-kit/workflows/tests/badge.svg
[codecov-url]: https://codecov.io/gh/simplymichael/express-api-starter-kit
[codecov-image]: https://img.shields.io/codecov/c/github/simplymichael/express-api-starter-kit?token=N22AUXCAU3
[bug]: https://github.com/simplymichael/express-api-starter-kit/labels/bug
[contribute]: https://github.com/simplymichael/express-api-starter-kit/blob/master/CONTRIBUTING.md
[fr]: https://github.com/simplymichael/express-api-starter-kit/labels/feature%20request
[pr]: https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request