Add hercule for apib processing and dredd for apib tests

pull/32/head
Florian Hartwich 2018-03-19 16:02:56 +01:00
parent 9dfbc74377
commit 50d532b17d
6 changed files with 3868 additions and 18 deletions

1
.gitignore vendored
View File

@ -4,6 +4,7 @@
dist/
tmp/
etc/
api/apib/documentation.apib
# dependencies
node_modules

View File

@ -1,5 +1,5 @@
# Data Structures
<!-- include(_auth.apib) -->
:[Gists](_auth.apib)
<!-- include(_squad.apib) -->
:[Gists](_squad.apib)

View File

@ -2,19 +2,19 @@ FORMAT: 1A
# Operation Pandora Trigger Command Center API Documentation
<!-- include(data_structures/index.apib) -->
:[Gists](data_structures/index.apib)
# Group General Introduction
<!-- include(base/datetime.apib) -->
:[Gists](base/datetime.apib)
# Group Access
## Authentication
<!-- include(auth/signup.apib) -->
:[Gists](auth/signup.apib)
<!-- include(auth/login.apib) -->
:[Gists](auth/login.apib)
# Group Account

34
api/dredd.yml Normal file
View File

@ -0,0 +1,34 @@
dry-run: null
hookfiles: null
language: nodejs
sandbox: false
server: npm start
server-wait: 3
init: false
custom: {}
names: false
only: []
reporter: base
output: []
header: []
sorted: false
user: null
inline-errors: false
details: false
method: []
color: true
level: info
timestamp: false
silent: false
path: []
hooks-worker-timeout: 5000
hooks-worker-connect-timeout: 1500
hooks-worker-connect-retry: 500
hooks-worker-after-connect-wait: 100
hooks-worker-term-timeout: 5000
hooks-worker-term-retry: 500
hooks-worker-handler-host: 127.0.0.1
hooks-worker-handler-port: 61321
config: ./dredd.yml
blueprint: ./apib/documentation.apib
endpoint: 'http://localhost:8091/api'

3832
api/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -12,7 +12,10 @@
"lint": "eslint '**/*.js'",
"test": "mocha --require ./test/config/spec_helper.js",
"e2e": "NODE_ENV=test node server.js",
"api:docs": "$(npm bin)/aglio --theme-variables slate -i ./apib/documentation.apib -o ../public/api-docs.html"
"api:compile-doc": "$(npm bin)/hercule apib/dev-doc.apib -o apib/documentation.apib",
"api:publish-doc": "$(npm bin)/aglio --theme-variables slate -i ./apib/documentation.apib -o ../public/api-docs.html",
"api:test-doc": "$(npm bin)/dredd",
"api:doc": "npm run api:compile-doc && npm run api:publish-doc"
},
"dependencies": {
"async": "^2.5.0",
@ -40,8 +43,10 @@
"aglio": "^2.3.0",
"chai": "^3.5.0",
"chai-http": "^3.0.0",
"dredd": "^5.1.4",
"eslint": "^4.18.2",
"eslint-config-google": "^0.9.1",
"hercule": "^4.1.1",
"mocha": "^3.5.3",
"nodemon": "^1.14.12"
}