dashboard-server

A JSON file RESTful API with authorization based on json-server for zce/dashboard

Usage

# clone repo
$ git clone https://github.com/zce/dashboard-server.git <my-api-server>

# change directory
$ cd <my-api-server>

# install dependencies
$ yarn # or npm install

# serve with nodemon at http://localhost:3000
$ yarn dev

JWT Authorization Endpoints

with jsonwebtoken

POST `/tokens`

create token

# Content-type: x-www-form-urlencoded
$ curl -X POST -d "username=zce&password=wanglei" http://localhost:3000/tokens
# Content-type: application/json
$ curl -X POST -H "Content-type: application/json" -d "{\"username\":\"zce\",\"password\":\"wanglei\"}" http://localhost:3000/tokens

request body

{ username: 'zce', password: 'wanglei' }

GET `/tokens`

check token

$ curl -H "Authorization: Bearer <jwt-string>" http://localhost:3000/tokens

request headers

{
  headers: { Authorization: 'Bearer <jwt-string>' }
}

DELETE `/tokens`

revoke token

$ curl -X DELETE -H "Authorization: Bearer <jwt-string>" http://localhost:3000/tokens

request headers

{
  headers: { Authorization: 'Bearer <jwt-string>' }
}

JSON Server Resources Endpoints

Comments: /comments/:id?
Posts: /posts/:id?
Terms: /terms/:id?
Users: /users/:id?
Options: /options/:id?

To access and modify resources, you can use any HTTP method: GET POST PUT PATCH DELETE OPTIONS

Additional Endpoints

GET `/users/me`

get current login user information

$ curl -H "Authorization: Bearer <jwt-string>" http://localhost:3000/users/me

request headers

{
  headers: { Authorization: 'Bearer <jwt-string>' }
}

Backdoor Endpoints

GET `/backdoor/reset`

reset the database to its initial state

$ curl http://localhost:3000/backdoor/reset

GET `/backdoor/delay`

add a delay of 1000ms for each endpoint

$ curl http://localhost:3000/backdoor/delay

zce/locally-server - A JSON file RESTful API without JWT authorization

License

MIT © 汪磊

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Warning

Renovate failed to look up the following dependencies: Failed to look up npm package bson-objectid, Failed to look up npm package dotenv, Failed to look up npm package express-jwt, Failed to look up npm package faker, Failed to look up npm package json-server, Failed to look up npm package jsonwebtoken, Failed to look up npm package uuid, Failed to look up npm package nodemon, Failed to look up npm package standard.

Files affected: package.json

This repository currently has no open or pending branches.

Detected dependencies

npm

package.json

bson-objectid ^1.3.1

dotenv ^8.2.0

express-jwt ^6.0.0

faker ^4.1.0

json-server ^0.16.1

jsonwebtoken ^8.5.1

uuid ^8.3.0

nodemon 2.0.4

standard 14.3.4

travis

.travis.yml

Check this box to trigger a request for Renovate to run again on this repository

zce / dashboard-server Goto Github PK