config

Runtime configuration for the admin client.

---

/api/config

GET

Returns a runtime config object.

{
  "preFlight": {
    "env": "development",
    "port": 3100,
    "target": "https://jsonplaceholder.typicode.com"
  },
  "fakes": [
    "example"
  ],
  "strict": false,
  "recording": true,
  "active": true,
  "dump": true,
  "sleep": 0,
  "retryLockTimeout": 0,
  "disabledProjects": [ "project-foo" ]
}

• preFlight: pre-startup env vars and parameters
• fakes: active interceptors, see "fakes" directory for examples
• strict: match with request body, not just request method and uri
• recording: save response to db?
• active: if not active, will always request from remote party; global sleep may still be active
• dump: save json files on server into dumps folder
• sleep: global sleep in sec; affects all requests, use it to simulate slow responses. Blocking via yield/await.
• retryLockTimeout: sec; affects all requests, use it to protect remote server from accidental flooding on response 408.
• disabledProjects: list of deactivated projects (they are still in the db)

PUT

Modify runtime config.

body schema

• strict: boolean
• active: boolean
• recording: boolean
• dump: boolean
• sleep: number, integer, max: 10
• retryLockTimeout: number, integer, max: 10
• disabledProjects: array of (string, lowercase, token, max: 64)

---

/api/config/toggle-project/:project

params schema

• project: string, lowercase, token, max: 64

PUT

Toggle project. Accepts empty payload.
Returns empty body on success.

projects

Projects are containers. You can create "projectfoo" by calling
pied piper proxy through http://pied-piper.dev:3100/project-foo/proxy.

Project names may contain alphanumeric characters and underscores only.

---

/api/projects

GET

Returns a list of project names.

response

["foo", "bar", "baz"]

---

/api/projects/:project

params schema

• project: string, lowercase, token, max: 64

DELETE

Delete project by name, destroy collection in database.
Returns empty body on success.

proxied resources

Proxied resources are the responses recorded in the db.
They may be retrieved, modified or deleted.

---

/api/proxied-resources/:project

params schema

• project: string, lowercase, token, max: 64

GET

Get a list of resources. Response is an array of proxied resource objects.

DELETE

Flush all items. Returns empty body on success.

---

/api/sse/proxied-resources/:project

Server side events (SSE). Streaming endpoint.

GET

Gets a new proxied resource object.

---

/api/proxied-resource/:project/:id

GET

Disabled and sleep are optional, _id is mongo id.

{
  "_id": "5895c2d67334cc413176f0ec",
  "disabled": true,
  "sleep": 3,
  "lastModified": "2017-02-04T12:02:30.687Z",
  "request": {
    "body": { /*...*/ },
    "headers": { /*...*/ },
    "method": "GET",
    "target": "/posts",
    "uri": "https://jsonplaceholder.typicode.com/posts"  
  },
  "response": {
    "headers": { /*...*/ },
    "statusCode": 200,
    "body": { /*...*/ }
  }
}

PUT

Modify a stored resource object. Returns empty body on success.

body schema

• sleep: number, integer, max: 10
• disabled: boolean
• request: object
  • method: string, uppercase, valid: GET, POST, PUT, PATCH, DELETE
  • uri: string, uri: http & https
  • target: string,
  • body: object / array / null
  • headers: object
• response: object
  • body: object / array / null
  • headers: object
  • status: number, integer, min: 100, max: 600

DELETE

Deletes resource from db. Returns empty body on success.

---

/api/proxied-resource/toggle/:project/:id

params schema

• project: string, lowercase, token, max: 64
• id: string, 24 char mongo-id

PUT

Returns empty body on success.

proxy

The purpose of the project, transparently proxy calls from
remote endpoint to local client.

---

/:project/proxy/*

The main proxy api endpoint. Anything directed here will be
proxied transparently forward to the env.TARGET url.

GET, POST, PUT, PATCH, DELETE

params schema

• project: string, lowercase, token, max: 64

response

Remote payload.

• gzipped content will be extracted
• cert errors will be swallowed
• no body may be replaced with empty body (resulting in status 204)