How to add JWT authentication to Finale endpoints?

Use the auth milestone hook to validate tokens; the 'Protecting Finale REST Endpoints' section shows how to integrate authorization middleware by resolving promises based on authentication checks, allowing custom error responses.

Finale vs writing custom Express controllers for Sequelize: which is better?

Finale is faster for standard CRUD APIs with built-in querying, but custom controllers offer more control for non-standard operations. Choose based on your need for speed versus flexibility.

Can Finale handle bulk operations like batch inserts?

Finale focuses on per-resource CRUD operations; for bulk actions, you'll need to customize the write hooks or handle them outside Finale, as it's not supported out of the box.

How to customize error responses in Finale?

Errors can be thrown in milestone hooks using built-in classes like ForbiddenError, or by returning context.error(); the README demonstrates this in the 'Customize behavior' section with examples.

Does Finale support TypeScript or is it JavaScript-only?

The README doesn't mention TypeScript support, so it's likely JavaScript-focused; you may need to add your own type definitions or rely on community contributions for TypeScript compatibility.

Is Finale suitable for high-traffic production APIs?

It can be used in production, but benchmark performance as automatic endpoints might add overhead; optimize database queries in hooks, and consider pagination defaults to manage load.

Open-Awesome

Finale

JavaScript1.2.1

Generate flexible REST endpoints and controllers from Sequelize models in Express or Restify applications.

GitHub

187 stars36 forks0 contributors

What is Finale?

Finale is a Node.js library that automatically generates RESTful API endpoints from Sequelize models, eliminating the need to manually write CRUD controllers. It integrates seamlessly with Express or Restify, providing built-in features like filtering, pagination, and sorting while allowing deep customization through middleware hooks.

Target Audience

Backend developers building REST APIs with Node.js, Express, and Sequelize who want to reduce boilerplate and accelerate development of standard CRUD operations.

Value Proposition

Developers choose Finale for its ability to instantly create production-ready REST endpoints with advanced querying capabilities, while maintaining full control over authentication, authorization, and business logic through a flexible hook system.

Overview

Create flexible REST endpoints and controllers from Sequelize models in your Express app

Use Cases

Best For

Rapidly prototyping REST APIs with Sequelize models
Adding standard CRUD endpoints to existing Express applications
Implementing complex querying (filter, search, sort, pagination) with minimal code
Customizing API behavior with middleware without rewriting core logic
Building APIs that require fine-grained access control and authorization hooks
Migrating from Epilogue to support newer versions of Sequelize

Not Ideal For

Projects using non-Sequelize ORMs like Mongoose for MongoDB
APIs requiring GraphQL endpoints or real-time WebSocket communication
Applications with highly non-standard CRUD logic that doesn't fit automatic generation
Teams needing server-side rendering or full-stack frameworks outside Node.js

Pros & Cons

Pros

Automatic Endpoint Generation

Creates full CRUD routes from Sequelize models with minimal configuration, as shown in the getting started example where endpoints like POST /users and GET /users/:id are generated automatically.

Flexible Customization via Hooks

Uses milestone hooks (start, auth, fetch, etc.) to inject custom logic at any request stage, demonstrated in the 'Customize behavior' section with examples like adding authentication or caching.

Built-in Advanced Querying

Supports filtering, searching, sorting, and pagination out of the box via query parameters, detailed in the REST API section with curl commands for operations like ?sort=-name or ?q=james.

Association Handling

Manages nested resources and associations with options for shallow or deep payloads, though limited to one level of nesting as noted in the README.

Cons

Sequelize Lock-in

Tightly coupled to Sequelize; switching to another ORM would require a complete rewrite of the API layer, reducing flexibility for future changes.

Limited Nesting Depth

The README admits that deep payload handling for associations is only supported for one level of nesting and is not recursive, which can be restrictive for complex data models.

Verbose Setup for Customization

Configuration for middleware and hooks can become complex, as seen in examples requiring careful management of context objects and promises, increasing initial development time.

Legacy Project Risks

As a fork of the older Epilogue library, it might have less active maintenance or community support compared to newer alternatives, potentially leading to compatibility issues with future Sequelize versions.

Frequently Asked Questions

Related Projects

Prisma

Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite, MongoDB and CockroachDB

Stars47,378

Forks2,403

Last commit11 hours ago

TypeORM

TypeScript & JavaScript ORM for Node.js — supports PostgreSQL, MySQL, MariaDB, SQLite, SQL Server, Oracle, and more.

ORM

Last commit23 hours ago

Sequelize

Feature-rich ORM for modern Node.js and TypeScript, it supports PostgreSQL (with JSON and JSONB support), MySQL, MariaDB, SQLite, MS SQL Server, Snowflake, Oracle DB, DB2 and DB2 for IBM i.

Stars30,375

Forks4,348

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub