koa-data

koa-data

Koa-data is a node-based cli tool. You can quickly build koa backend service, according to the choice to generate router template and mongoDB database generic operation template. One set of interface to operate multiple tables, just pass the table name dynamically.

Language

English | 中文

Install

npm install koa-data -g

Usage and options introduction

1. use

• After the global installation is complete, the command line executes:

koa-data

2. options introduction

• packageName
• port (default 3000)
• router
• mongodb (dataBase)
• panel (dataView)

Project startup and configuration

• Go to the generated project directory and execute the command

node index.js

Attention: If you want to use the mongodb function interface, please make sure the environment is installed.
Config folder is Configuration(Default mogondb port: 27017, Default dataBase: test), Can be modified according to requirements.

Validation interface and data panel

• Once the project is started, you can use the test interface to verify, address: http://localhost:3000/base/test

• Data debugging panel to perform database CRUD operations.When the dataPanel option is checked, you can access the dataView。

Mongodb Operation Interface:

Default address: http://localhost:3000

Use the address to spell up the route. As inserted in the interface: http://localhost:3000/base/insert_one

// Insert /base/insert_one
{
  "cname" : "user", // collection
  "doc" : {   // filed
    "name" : "Daw",
    "password" : "123456"
  }
}

// Delete one item by _id /base/delete_one
{
  "cname" : "user", // collection
  "_id" : "5eef0ebea1ddd4ed2446c673"
}
// Delete all in the collection /base/delete_all
{
  "cname" : "user"
}

// Update（replace） /base/replace_one
{
  "cname" : "user", // collection
  "_id" : "5eef0ebea1ddd4ed2446c673",
  "doc" : {
    "name" : "Daw1",
    "password" : "456789"
  }
}

// Query a piece of data by _id /base/find_one
{
  "cname" : "user", // collection
  "_id" : "5eef0ebea1ddd4ed2446c673"
}
// Query multiple data（pagination，filter，projection） /base/find_all
{
  "cname" : "user", // collection
  "page_num" : 1, // First page
  "page_size" : 10, // 10 per page
  "filter": { "name": "Daw" }, // filter name: "Daw"
  "projection" : "name password"  // projection
}

Of course, the interface conditions for querying multiple data are optional and can be left unfilled or optional.

{
  "cname" : "user"
}

Finally

Welcome to interact. In addition, if this project helps you, I hope you can click a star, thank so much!