Git Product home page Git Product logo

dashboard-server's Introduction

dashboard-server

Build Status Dependency Status devDependency Status Code Style

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

Related

License

MIT © 汪磊

dashboard-server's People

Contributors

renovate[bot] avatar zce avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.