https://github.com/negi524/mock_api
https://github.com/negi524/mock_api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/negi524/mock_api
- Owner: negi524
- Created: 2019-06-10T14:21:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T21:10:31.000Z (over 2 years ago)
- Last Synced: 2023-03-02T20:11:25.369Z (over 2 years ago)
- Size: 307 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 簡易モック API
## 利用パッケージ
1. [json-server](https://github.com/typicode/json-server)
1. [http-server](https://www.npmjs.com/package/http-server)
### json-server
#### 使い方
1. git リポジトリをクローン or ダウンロードする
1. `npm i`でパッケージをインストールする
1. レスポンスとして返却したい JSON ファイルを作成する（db.json を参考にすると良い）
1. 対象の JSON ファイルを引数にして、`npm run server`コマンドを実行する
1. `Resourses`のパスにアクセスすると、JSON が返却される
#### コマンド
db.json のデータを元に api を起動する時
```
$ npm run server db.json
```
routes のマッピングを行いたい時
```
$ npm run server db.json -- --routes routes.json
```
8080port を指定してローカルサーバを立ち上げたい時
```
$ npm run server db.json -- --port 8080
```
#### db.json の作成場所
`npm run server`の起動引数に指定できれば良いので、どこに作成しても良いです。
git 管理外のディレクトリ`tmp`を作成してあるので、そこに格納することをお勧めします。
### http-server