Interfaces
Add any number of interfaces to a single configuration to interact with. Interfaces run a number of actions when triggered.
Defining Interfaces
Defining interfaces are simple. Declare an interfaces section and create your identifiers for each interface.
Usage
name: get-vault-secrets
interfaces:
prod/user-login:
prod/user-details:
Options
| Name | Type | Description |
|---|---|---|
summary | string (optional) | Short summary on what this api interface is for |
description | string (optional) | Longer description on what this api interface is for |
output | string (required) | How to interact with this api
|
method | string (required) | The method to call this api
|
route | string (optional) | Define the route the api will be called on. The interface identifer is the default route and will be used if no route is defined. |
tags | array (optional) | Array of strings containing tags |
actions | array (optional) | An array of instructions and transformations that occur when an API interface is called |
Usage
name: get-vault-secrets
interfaces:
prod/user-login:
summary: production endpoint
description: production endpoint for login service
tags: ['env:production', 'version:1.0.0']
output: http
method: POST
actions:
- name: CheckInput
- name: VerifyUser
- name: VerifyPassword