- Documentation
- deema - CLI toolkit
- dc-api-client - API client
- dc-api-mongo - Mongoose based MongoDB driver
- Examples
- jwa
- vercel/ms
- μWebSockets.js
- watch
- ts-node (optional)
- typescript (optional)
📙
├── ⚙️ controllers Request controllers
├── 🗃️ models Models for working with DB
│ └── 📁 <driver> Database driver name (Optional)
│ └── 📜 <model> Model name (js or json)
├── ️📃 config.json Configuration file
└── ⏱ startup.js Script, that was started before starting API serverInstallation with Deema CLI (recommended)
1) You can use deema gen project <ProjectName> to create project.
You can also optionally use arguments:
--tsor--typescriptto create typescript project;- you can use
--installto install packages immediately after creating a project.
2) Run npm install or yarn (skip if you created project with --install)
3) Run deema serve
4) Done!
0) Run npm init or yarn init
1) Install package - npm i dc-api-core --save or yarn add dc-api-core
2) Run npm exec dc-api-core init or yarn dc-api-core init
3) Run npm run dc-init or yarn dc-init
4) Run npm start or yarn start
5) Done!
| Field | Default | Description |
|---|---|---|
db |
Optional | Object |
db[driverName] |
Code of database driver | |
db[driverName].name |
Required | Database name |
db[driverName].port |
Defined by plugin | Database port |
db[driverName].user |
Optional | Database username |
db[driverName].pass |
and password | |
db[driverName].srv |
Optional for mongo | Boolean, true - use srv |
session.secret |
Required | Private string for cookie |
session.store |
Required | Database config name |
session.ttl |
3d (3 days) |
Session lifetime in vercel/ms format, false - infinite |
ssl |
Optional | Enables HTTPS mode if filled |
ssl.* |
Optional | Any μWS.SSLApp options field |
ssl.key |
Required | Local path to private key |
ssl.cert |
Required | Local path to certificate file |
plugins |
[] |
Array of plugin packages names |
origin |
Origin header |
Accept requests only from this origin |
port |
8081 |
API listing port |
ws_timeout |
60 |
WebSocket request waiting timeout in seconds |
ignore |
[] |
Excluded directories in development mode |
isDev |
Read-only | true if using --dev argument |
dev |
{} |
Config to merge if isDev is true |
ttl |
0 |
WebSocket TTL in seconds, 0 - disabled |
typescript |
false |
TypeScript-support |
Example:
{
"port": "$env", // Equals value of process.env.PORT
"db": {
"mongo": {
"host": "localhost",
"name": "test-db"
}
},
"plugins": ["dc-api-mongo"],
"session": {
"secret": "super secret string",
"store": "mongo"
},
"ssl": {
"cert": "/etc/letsencrypt/live/awesome.site/cert.pem",
"key": "/etc/letsencrypt/live/awesome.site/privkey.pem"
},
"dev": {
"port": 8081,
"db": {
"mongo": { "name": "test-dev-db" }
}
}
}Example:
// JS
const db = require('dc-api-mongo').connect();
// TS
import db from 'dc-api-mongo/mongo';
async function main() {
const result = await db.Model.findOne();
console.log(result);
}
main();Where Model is your model name.
If you're using MySQL, use mysql as database driver (don't forget to apply plugin first).
const db = require('dc-api-mysql').connect();
async function main() {
const result = await db.Model.findOne();
console.log(result);
}
main();Where Model is your model name.
For first, install plugin package via npm or yarn.
After this add name of plugin package to plugins array in config.json.
Example config.json:
{
// ...
"plugins": ["dc-api-mongo"]
}If you want create your own plugin, read plugin development documentation
| Function | Example | Description |
|---|---|---|
this.session.<name> |
this.session.name = 'User' |
Set session data |
this.session.save() |
await this.session.save() |
Save session data |
this.session.destroy() |
await this.session.destroy() |
Clear all session data |
module.exports = class Controller {
async test () {
this.session.name = 'test';
await this.session.save();
this.send('saved');
}
}Will be executed before calling action method in controller.
If the onLoad function returns false, the request will be rejected.
module.exports = class Test {
onLoad () {
if (!this.session.user) return false;
}
}Require config module:
// JS
const config = require('dc-api-core/config');
// TS
import config from 'dc-api-core/config';Get data:
config.<your_param>const config = require('dc-api-core/config');
module.exports = class Test {
index() {
this.send(config.myParam);
}
}Register route in startup script:
// startup.js
const Router = require('dc-api-core/router');
Router.register('/testing/files/${id}/${file}.jpg', 'Test.getFile');Now requests like /testing/files/some-id/secret_file.jpg will call getFile method of Test controller.
// controllers/Test.js
class Test {
async getFile () {
this.send(this.params);
// Will send { "id": "some-id", "file": "secret_file" }
}
}
module.exports = Test;-
Document new
config.cors.headers -
Support for glibc < 2.18
-
Typing (
.d.ts) files -
Automatic package publication when all tests are passed
-
More functionality tests
-
Clusterization/multi-threading support
-
Edit pages "API" > "Database driver" and "Plugins" > "Basics" of docs