Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zce/dashboard-server
A JSON file RESTful API with authorization based on json-server
https://github.com/zce/dashboard-server
fake json-api json-server jsonwebtoken jwt now rest-api restful
Last synced: about 2 months ago
JSON representation
A JSON file RESTful API with authorization based on json-server
- Host: GitHub
- URL: https://github.com/zce/dashboard-server
- Owner: zce
- License: mit
- Created: 2017-03-24T10:25:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T04:36:51.000Z (11 months ago)
- Last Synced: 2024-10-12T08:50:32.873Z (2 months ago)
- Topics: fake, json-api, json-server, jsonwebtoken, jwt, now, rest-api, restful
- Language: JavaScript
- Homepage: https://dashboard-server.now.sh
- Size: 385 KB
- Stars: 52
- Watchers: 7
- Forks: 22
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dashboard-server
[![Build Status][travis-img]][travis-url]
[![Dependency Status][dependency-img]][dependency-url]
[![devDependency Status][devdependency-img]][devdependency-url]
[![Code Style][style-img]][style-url]
> A JSON file RESTful API with authorization based on [json-server](https://github.com/typicode/json-server) for [zce/dashboard](https://github.com/zce/dashboard)
## Usage
```sh
# clone repo
$ git clone https://github.com/zce/dashboard-server.git
# change directory
$ cd
# install dependencies
$ yarn # or npm install
# serve with nodemon at http://localhost:3000
$ yarn dev
```
## JWT Authorization Endpoints
> with [jsonwebtoken](http://jwt.io)
### POST `/tokens`
create token
```sh
# 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
```js
{ username: 'zce', password: 'wanglei' }
```
### GET `/tokens`
check token
```sh
$ curl -H "Authorization: Bearer " http://localhost:3000/tokens
```
request headers
```js
{
headers: { Authorization: 'Bearer ' }
}
```
### DELETE `/tokens`
revoke token
```sh
$ curl -X DELETE -H "Authorization: Bearer " http://localhost:3000/tokens
```
request headers
```js
{
headers: { Authorization: 'Bearer ' }
}
```
## 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
```sh
$ curl -H "Authorization: Bearer " http://localhost:3000/users/me
```
request headers
```js
{
headers: { Authorization: 'Bearer ' }
}
```
## Backdoor Endpoints
### GET `/backdoor/reset`
reset the database to its initial state
```sh
$ curl http://localhost:3000/backdoor/reset
```
### GET `/backdoor/delay`
add a delay of 1000ms for each endpoint
```sh
$ curl http://localhost:3000/backdoor/delay
```
## Related
- [zce/locally-server](https://github.com/zce/locally-server) - A JSON file RESTful API without JWT authorization
## License
[MIT](LICENSE) © [汪磊](https://zce.me)
[travis-img]: https://img.shields.io/travis/com/zce/dashboard-server.svg
[travis-url]: https://travis-ci.com/zce/dashboard-server
[dependency-img]: https://img.shields.io/david/zce/dashboard-server.svg
[dependency-url]: https://david-dm.org/zce/dashboard-server
[devdependency-img]: https://img.shields.io/david/dev/zce/dashboard-server.svg
[devdependency-url]: https://david-dm.org/zce/dashboard-server?type=dev
[style-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[style-url]: https://standardjs.com/