Getting started

Install dependencies

To get started with Inversify HTTP, first install the required packages.

Begin by installing the inversify packages and reflect-metadata:

npm

  npm install inversify reflect-metadata @inversifyjs/http-core

pnpm

  pnpm install inversify reflect-metadata @inversifyjs/http-core

yarn

  yarn add inversify reflect-metadata @inversifyjs/http-core

warning

Make sure to enable the Experimental Decorators and Emit Decorator Metadata options in your tsconfig.json.

Choose an HTTP adapter

Inversify HTTP works with several HTTP frameworks. Choose the adapter that best fits your needs:

Express v4

  npm install @inversifyjs/http-express-v4

Express

  pnpm install @inversifyjs/http-express

Fastify

  yarn add @inversifyjs/http-fastify

Hono

  yarn add @inversifyjs/http-hono

Configure server

After installing the packages, create a server to listen for incoming requests. Below is a basic example of setting up an Express server with Inversify HTTP.

const container: Container = new Container();

const adapter: InversifyExpressHttpAdapter = new InversifyExpressHttpAdapter(
  container,
);

const application: express.Application = await adapter.build();

application.listen(3000);

The server is ready to receive requests, but there are no handlers yet. Add a Controller to handle incoming requests.