Skip to content

Vista-NJTECH/vistalab-backend

Repository files navigation

Introduction

南京工业大学Vista远景实验室后端API,网站点击这里

Features

□ jwt
□ joi
□ blurhash
□ Group权限用户组

Environment

node -v
18.12
npm -v
8.19.2

Run

run with node

npm install
node app.js

run with docker

build docker

docker build . -t vistaweb-backend:v1

run docker

docker run --restart=unless-stopped -p 8181:8181 --name back --link vistasql:db -d vistaweb-backend:v1

API Document

API文档部署采用apidoc插件
详细文档请见apidoc官网地址

Install

npm install apidoc -g

Generate Doc Html

~/projects/web$ apidoc -i routes/ -o apidoc/

Config

  • 在根目录下apidoc.json进行配置
  • 在根目录下package.json中的apidoc属性进行网站配置
  • app.js中配置apidoc为静态路由目录

Address

http://localhost:8181/apidoc/index.html