Commit bab3d230 authored by Eric Eastwood's avatar Eric Eastwood

Add readme

parent 95ede412
Pipeline #6092550 failed
lint:
image: node:boron
cache:
paths:
- node_modules/
stages:
- build
- test
- deploy
build:
stage: build
script:
- npm install
artifacts:
paths:
- node_modules/
#- dist/ # Generated during the server startup
tags:
- nodejs-app
test:
stage: test
script:
- npm run lint
tags:
- nodejs-app
deploy:
stage: deploy
script:
- echo "TODO: Deploy"
tags:
- nodejs-app
# API Lab
```
npm i
npm start
```
Documentation for the current routes is available at the root (automatically generated).
```
http://localhost:8000/
```
The swagger document is also served for reference.
```
http://localhost:8000/routes.yml
```
## Update Routes/Endpoints
See `routes.yml` ([Swagger](http://swagger.io/specification/) document)
### Initial mock data
See `data.json` (Array of [Resource objects](https://github.com/BigstickCarpet/swagger-express-middleware/blob/master/docs/samples/walkthrough2.md#pre-populated-data))
## Testing
Currently only linting available for Swagger document `npm run lint`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment