1.0.0 • Published 4 years ago

create-node-api-generator v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

create-api

This is a lightweight boilerplate for creating APIs. It does not require any npm libraries except for the in-built Node modules, so it usually requires some handiwork and a trial-and-error process, but this compensates for its speed and minimalism.

Features

  • JSON output
  • Custom Headers that removed some possibly vulnerable headers
  • Separate reusable models that handle messaging and defaulting data
  • Custom Route Handler.
  • Method, Route and Entry Tokens that allow or deny access to data.

To-Do list

  • Header Options
  • Route Handlers: Permitted, Not Found
  • Method Handlers
  • Customizable Default Response Files
  • All types of Requests Working
  • Ready for 1st publish
  • XML
  • Plain Text
  • Function to create a route
  • Authentication
  • connect to a MongoDB database
  • Setup connection to front-end
  • API Keys
  • Limit query per hour and per user
  • Timeout after 30s
  • Maintain session state
  • Suggestions for Routes
  • User Authentication
  • CORS
  • Documentation

Documentation

  • A description of the API
  • Links to technical references and guides
  • How to set up the project as a developer
  • How to test the project
  • How to deploy the project
  • Dependency management
  • Contribution guide
  • Code of conduct
  • License
  • Gratitude