Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/armour/vue-typescript-admin-mock-server

🖥 Mock server for vue-typecript-admin-template project
https://github.com/armour/vue-typescript-admin-mock-server

admin mock mock-server typescript vue

Last synced: 10 days ago
JSON representation

🖥 Mock server for vue-typecript-admin-template project

Host: GitHub
URL: https://github.com/armour/vue-typescript-admin-mock-server
Owner: Armour
License: mit
Created: 2019-06-06T07:34:29.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-12-10T19:38:12.000Z (almost 2 years ago)
Last Synced: 2024-10-31T13:46:04.701Z (17 days ago)
Topics: admin, mock, mock-server, typescript, vue
Language: JavaScript
Homepage: https://vue-typescript-admin-mock-server.armour.now.sh/mock-api/v1/transactions
Size: 62.5 KB
Stars: 41
Watchers: 4
Forks: 40
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # vue-typescript-admin-mock-server

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Template from jarvis](https://img.shields.io/badge/Hi-Jarvis-ff69b4.svg)](https://github.com/Armour/Jarvis)

Mock server for [vue-typecript-admin-template](https://github.com/Armour/vue-typescript-admin-template) project

## Demo link

[Demo](https://vue-typescript-admin-mock-server.armour.now.sh/mock-api/v1/transactions) (used by vue-typecript-admin-template)

## Overview

The javascript code under `api` folder in this project was generated from the typescript source code located at [here](https://github.com/Armour/vue-typescript-admin-template/tree/master/mock) (by running `tsc` command in this directory). The only manually change is to rename the `mock-server.js` to `index.js`.

## Swagger

The url schema is based on [Swagger config file](https://github.com/Armour/vue-typescript-admin-template/blob/master/mock/swagger.yml) and follows REST api standard.

```txt

info: {

  name: 'Mock API',

  description: 'Mock API for vue-typescript-admin-template.',

  version: '1.0.0'

},

paths: {

  get: [

    '/mock-api/v1/articles',

    '/mock-api/v1/articles/:id',

    '/mock-api/v1/pageviews',

    '/mock-api/v1/transactions',

    '/mock-api/v1/roles',

    '/mock-api/v1/routes',

    '/mock-api/v1/users',

    '/mock-api/v1/users/:username'

  ],

  post: [

    '/mock-api/v1/articles',

    '/mock-api/v1/roles',

    '/mock-api/v1/users/register',

    '/mock-api/v1/users/login',

    '/mock-api/v1/users/logout',

    '/mock-api/v1/users/info'

  ],

  put: [

    '/mock-api/v1/articles/:id',

    '/mock-api/v1/roles/:id',

    '/mock-api/v1/users/:username'

  ],

  delete: [

    '/mock-api/v1/articles/:id',

    '/mock-api/v1/roles/:id',

    '/mock-api/v1/users/:username'

  ]

}

```

## Try it on your own computer

First install all dependencies:

```bash

yarn # OR npm install

```

Then you can set up the server:

```bash

yarn mock # OR npm run mock

```

or use the `vercel dev` command.

## Host

This mock server is hosted by [Vercel](https://vercel.com/guides/using-express-with-vercel).

## Contributing

See [CONTRIBUTING.md](https://github.com/Armour/vue-typescript-admin-mock-server/blob/master/.github/CONTRIBUTING.md)

## License

[MIT License](https://github.com/Armour/vue-typescript-admin-mock-server/blob/master/LICENSE)