@redwoodjs/api-server

Redwood Fastify Server

About

This package contains code for Redwood's Fastify server:

• used during local dev for API Side
• used for Production Deploys requiring long-running process (i.e. not serverless)

TODO

• add code structure walk-through
• add package leads
• add contributing related info

package.json Server Binaries

Run the Redwood Fastify Server programmatically.

From package.json

  "bin": {
    "rw-api-server-watch": "./dist/watch.js",
    "rw-log-formatter": "./dist/logFormatter/bin.js",
    "rw-server": "./dist/index.js"
  },

Note: because we use Yargs to parse in index, using these within the context of a Redwood CLI command will throw due to Yargs object "collision". Needs to be re-architected in the future.

rw-server

Indended for dev and prototyping (i.e. pre-production).

This command runs both the API and Web server on the same port and is not performant at scale for production use. Instead, use the separate commands to run the API and (if needed) Web servers independently, along with tools like PM2, Nginx, or Kubernetes, which appropriately handle concurrent requests, errors, static asset, etc. for production contexts.

• Runs web on redwood.toml web.port (default 8910)
• API listens on web port at path redwood.toml web.apiUrl
• Command Options:
  • port (default 8910)
  • socket (optional)
  • apiHost (default redwood.toml web.apiUrl)

rw-server api

For production use.

• Runs api on redwood.toml api.port (default 8911)
• Command Options:
  • port (default 8911)
  • socket (optional)
  • apiRootPath (default '/')

rw-server web

Not optimized for production use at scale (see comments above for rw-server). Recommended to use CDN or Nginx as performant alternatives.

• Runs web on redwood.toml web.port (default 8910)
• GraphQL endpoint is set to redwood.toml web.apiUrl/graphql
• Command Options:
  • port (default 8910)
  • socket (optional)
  • apiHost (default redwood.toml web.apiUrl)

Similar packages

Other packages similar to @redwoodjs/api-server

apollo-server

Apollo Server is a community-driven, open-source GraphQL server that works with any GraphQL schema. It provides a robust set of features for building a GraphQL API, including schema stitching, subscriptions, and more. Compared to @redwoodjs/api-server, Apollo Server is more flexible and can be used with any JavaScript framework.

express

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. It is highly extensible and can be used to build RESTful APIs, server-side rendered applications, and more. While @redwoodjs/api-server is tailored for RedwoodJS applications, Express can be used in a wide variety of projects.

serverless

The Serverless Framework is an open-source framework that allows you to build and deploy serverless applications on various cloud providers. It supports AWS Lambda, Google Cloud Functions, Azure Functions, and more. Compared to @redwoodjs/api-server, the Serverless Framework provides more extensive support for different cloud providers and is not limited to RedwoodJS applications.