Class Febby

Deprecated

Initializes and starts the Febby application.

Deprecated

Closes the database connection used by the Febby application (alias for closeDbConnection).

Returns

Example

febby.closeConnection();

Deprecated

Closes the database connection used by the Febby application.

Returns

Example

febby.closeDbConnection();

Configures CRUD (Create, Read, Update, Delete) operations for a model and registers corresponding routes.

Returns

Example

febby.crud("/api/users", {
  crud: true,
  middlewares: [],
  get: [GetMiddleware],
  post: [],
  put: [PutMiddleware],
  delete: [],
}, userModel);

Deprecated

• use case is very rare so deprecating it finalHandler will register final middleware function

Returns

Deprecated

Registers a final middleware function to be used at the end of the middleware chain.

Returns

Example

febby.finalHandler((req, res, next) => {
  // Final middleware logic
  next();
});

Loads default middlewares such as morgan, body-parser, helmet, and cors for the express app.

Returns

• A promise that resolves once the middlewares are loaded.

Example

await febby.loadDefaultMiddlewares();

Load OpenAPI configuration from a YAML file and register routes based on the specification.

This method is used when you want to create your application using an OpenAPI specification in YAML format. It reads the YAML file, parses it, and generates routes and controllers based on the specification. include x-controller,x-middlewares in each route definition for mapping.

Returns

A Promise that resolves when the OpenAPI configuration is successfully loaded and routes are registered.

Example

// Load OpenAPI configuration from a YAML file and register routes with default options.
await loadOpenAPIConfigYAML("/path/to/openapi.yaml");

Example

// Load OpenAPI configuration from a YAML file and customize controller and middleware options.
const customOptions = {
  controllers: {
    UserController: (req, res) => { /* Custom UserController logic * / },
  },
  middleware: [
    (req, res, next) => { /* Custom middleware logic * / },
  ],
   openApiValidatorOptions: {
    validateApiSpec: true,
    validateResponses: true,
    validateRequests: true,
  }
};
await loadOpenAPIConfigYAML("/path/to/openapi.yaml", customOptions);

Example

// Load OpenAPI configuration from a YAML file and provide controller and middleware options.
const customOptions = {
  controllers: path.join(__dirname, 'controllers'), // path to controller directory
  middleware: path.join(__dirname, 'middlewares'), // path to middleware directory
   openApiValidatorOptions: {
    validateApiSpec: true,
    validateResponses: true,
    validateRequests: true,
  }
};
await loadOpenAPIConfigYAML("/path/to/openapi.yaml", customOptions);

Registers a middleware function to be used in the application.

Returns

Example

febby.middleware((req, res, next) => {
  // Custom middleware logic
  next();
});

Deprecated

Registers an array of middleware functions to be used in the application.

Returns

Example

febby.middlewares([
  (req, res, next) => {
    // Custom middleware 1 logic
    next();
  },
  (req, res, next) => {
    // Custom middleware 2 logic
    next();
  },
]);

Defines a Mongoose model for data storage and retrieval.

Returns

• The Mongoose model instance.

Example

const User = febby.model("User", userSchema);

Retrieves all defined Mongoose models.

Returns

• An object containing all defined Mongoose models.

Example

const models = febby.models();
const User = models["User"];

Registers a route with a specified path, HTTP method, handler function, and optional middlewares.

Returns

Example

febby.route({
  method: "get",
  path: "/api/users",
  handler: (req, res) => {
    // Handle GET request for /api/users
  },
  middlewares: [],
});

Creates and returns a new router instance.

Returns

• The newly created router instance.

Example

const apiRouter = febby.router("/api");

Deprecated

Registers multiple routes from an array of route configurations.

Returns

Example

febby.routes([
  {
    method: "get",
    path: "/api/users",
    handler: (req, res) => {
      // Handle GET request for /api/users
    },
  },
  {
    method: "post",
    path: "/api/users",
    handler: (req, res) => {
      // Handle POST request for /api/users
    },
  },
]);

Deprecated

Shuts down the Febby application.

Returns

Example

febby.shutdown();

Starts the Febby application.

Returns

• A promise that resolves once the application has started.

Example

await febby.start();