Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 3.5 KB

README.md

File metadata and controls

113 lines (86 loc) · 3.5 KB
Raw

spryjs 🚀

JavaScript-based framework that enables rapid development of Web API's.

🇪🇸 📄 Español 👈

Consulta la documentación en Español.

Example

Checkout the spryjs-example repo for full example reference.

Install

npm i @codiks/spryjs

Description

Register entities with a given model, full CRUD will be created

  • /api/entity

    • GET
    • POST

  • /api/entity/:id

    • GET
    • DELETE
    • PUT

Beta version. Current functionality

  • Create express app listening on a given port.
  • Mongoose library incoporated. Easy to configure
  • Morgan middleware incorporated.

Pending documentation.

Basic usage

Define a model for MongoDB

entities/books/index.ts

export const Book = {
  name: String,
  description: String,
  code: String
}

export default Book;

Import SpryJs and initialize the server

The following code will create a full CRUD endpoint on localhost:5000/api/bookmanagement having the above Book model

index.ts

/** dotenv */
import dotenv from 'dotenv';
dotenv.config();

import SpryJs, { EntityConfig } from "@codiks/spryjs";
import Book from "./entities/book";
import { MONGO_CS, TOKEN_SECRET, SALT, PORT } from "./constants"

const spryjs = new SpryJs();

/**Initialize SpryJs */
spryjs.init(PORT).then((app) => {

  /** Enable MongoDB. Need to pass connection string as a parameter*/
  spryjs.useMongo(`${MONGO_CS}`);

  /** Enable morgan middleware */
  spryjs.useMorgan();

  /** Enable authentication. This will create the /api/user endpoint with the default user schema
   * (username, password). POST action will act as the register endpoint. The body must contain a JSON object
   * with username and password variables. Once registered, 
   */
  spryjs.useAuthentication(`${TOKEN_SECRET}`, `${SALT}`);

  /** Register Book entity. This will create the CRUD endpoints for /bm 
   * using Book entity for persistance.
   * Notice that some enpoints are protected for only authorized users
   */
  let bookConfig: EntityConfig = {
    name: 'Book',
    model: Book,
    path: 'bm',
    keyword: 'code',
    config: {
      /** Let's protect some endpoints to only authorized users.
       * All other endpoints not mentioned in auth object will be non-protected
       * and will not require a token in the authorization header
      */
      auth: {
        post: true,
        delete: true,
        put: true
      }
    }
  }
  spryjs.registerEntity(bookConfig).then(() => {
  })
})

💣 Important 💣

English 🇺🇸

This framework has been created given the repeated times this configuration was used in multiple projects for rapid prototype development. Even when this architecture has been used (and it's currently used) in production environments further configuration might be required. The intention of this framework is to allow new developers to easyly start developing Web API's without having to do a bunch of configurations.

Español 🇪🇸

Este framework ha sido creado dadas las veces que esta configuración se usó en múltiples proyectos para desarrollo rápido de prototipos. Incluso cuando esta arquitectura se ha utilizado (y se utiliza actualmente) en entornos de producción, es posible que se requiera una configuración adicional. La intención de este marco es permitir que los nuevos desarrolladores comiencen a desarrollar fácilmente API web sin tener que hacer un montón de configuraciones.