Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 4.2 KB

README.md

File metadata and controls

106 lines (73 loc) · 4.2 KB
Raw

api

adriancleung-api version

Backend code for my website and services

Development

This is a Node.js API using Express with TypeScript. The recommended development environment for this project is using dev containers.

This project uses the following:

  • Express
  • Postgres
  • Sequelize
  • Redis
  • YouTube Data API v3
  • Firebase

An OAuth 2.0 Client ID with Application Type as Desktop app must be generate to access the YouTube Data API v3. An OAuth consent screen must be created with the following scopes:

  • https://www.googleapis.com/auth/youtube.force-ssl

You can retrieve your Firebase service account key from Firebase > Project settings > Service accounts > Firebase Admin SDK > Generate new private key

Clone this repository:

git clone https://git.adrianleung.dev/api

Dev Container Development

Create a copy of .env.TEMPLATE as .env and replace the values with the proper values.

Local Development

Grab the environment variables from .env.TEMPLATE and replace the values before adding to your environment.

API

NOTE: Documentations are being reworked!

Definitions

All available routes are defined using OpenAPI Specification (OAS) 3.0.3. OAS is a standard, language-agnostic interface that defines RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network inspection.

The definitions can be accessed at api.adrianleung.dev/v[major] where major is the major release number of the API server. The current definitions can be found here. All definitions uses and conforms to the OpenAPI Specification.

Documentation

This project uses swagger-jsdoc and swagger-ui-express to generate the OpenAPI Specification document containing the definitions. If developing with dev containers, the Swagger Editor is provided for visual aid when creating JSDoc definitions. JSDoc definitions are created in the index.js file for each route to keep route.js clutter free. Common auth, schema, and response components are defined in docs/openapi.yaml. Documentation on how to create definitions and components can be found here.

Tasks

Tasks can run at specific times based on GNU crontab

Allowed fields

  ┌────────────── second (optional)
  │ ┌──────────── minute
  │ │ ┌────────── hour
  │ │ │ ┌──────── day of month
  │ │ │ │ ┌────── month
  │ │ │ │ │ ┌──── day of week
  │ │ │ │ │ │
  │ │ │ │ │ │
  * * * * * *

Allowed values

field value
second 0-59
minute 0-59
hour 0-23
day of month 1-31
month 1-12 (or names)
day of week 0-7 (or names, 0 or 7 are sunday)

Specifying tasks

To add a task, create a folder in src/tasks with the name of the task. Create a file in the directory called handler.ts. Follow the following structure:

const schedule = '* * * * *'; // Use the GNU crontab format above
const endpoint = async () => {
  // Code here...
  // Should not return anything
};

export default [endpoint, schedule];