Check out code example

Write the API interface JSON description file, place it in the application apis directory, run yao start When the command starts the service, the engine will generate the RESTFul API interface as defined by the interface description. Yao currently supports RESTFul API to describe MQTT, Socket, WEB Socket API; it is used for data collection and docking, instant messaging, IoT and other types of projects.

The business interface description file is a JSON text file named with lowercase English letters + .protocol name + .json extension, <name>.<protocol>.json;

An interface (API) document of the http protocol, which can define a set of APIs, and can bind a process (process) to each API, and the system automatically calls the process and returns the result of the process call;

The API will be accessed through the route /api/<group>/<path>, the request succeeds and responds to the status code, Content-Type and the return value of the process (process) defined in out, and the request fails and responds to the exception status code and error messages in JSON format [see exception specification](#Exception specification).

The parameter list defined in in will be used as input parameters to the process. Supports the use of :param , :payload , $param.field name and other variables to bind request parameters.

Object File data structure

{
  "code": 500,
  "message": "Data with ID=12 does not exist",
  "context": {
    "field": "id"
  }
}

The returned status is consistent with the error code. For example, if the HTTP Response status code is 400~599, it will be regarded as a program processing exception.

The meaning of the error code is basically the same as the meaning of the HTTP protocol status code, which is convenient for RESTFul API writing, unified exception handling and engineers to understand the meaning of the error code.

Using gurad in the request api is similar to using middleware to filter requests and intercept some requests that do not meet the conditions. When defining the api, specify the handler used by the guard field.

Specifies that the entire grouping api should authenticate the login

{
  "name": "Drop down search",
  "version": "1.0.0",
  "description": "Drop down search",
  "guard": "bearer-jwt",
  "group": "select",
  "paths": [
    {
      "path": "/category",
      "method": "GET",
      "process": "flows.category",
      "in": [],
      "out": {
        "status": 200,
        "type": "application/json"
      }
    }
  ]
}

Specifying an interface alone requires authentication and login

{
  "name": "Drop down search",
  "version": "1.0.0",
  "description": "Drop down search",
  "group": "select",
  "paths": [
    {
      "path": "/category",
      "method": "GET",
      "guard": "bearer-jwt",
      "process": "flows.category",
      "in": [],
      "out": {
        "status": 200,
        "type": "application/json"
      }
    }
  ]
}

{
  "name": "Drop down search",
  "version": "1.0.0",
  "description": "Drop down search",
  "guard": "-",
  "group": "select",
  "paths": [
    {
      "path": "/category",
      "method": "GET",
      "process": "flows.category",
      "in": [],
      "out": {
        "status": 200,
        "type": "application/json"
      }
    }
  ]
}

Create a new flows/category.flow.json file:

{
  "label": "Category Tree",
  "version": "1.0.0",
  "description": "Category Tree",
  "nodes": [
    {
      "name": "Category",
      "engine": "xiang",
      "query": {
        "select": ["id", "name", "name as label", "id as value", "parent_id"],
        "wheres": [{ ":deleted_at": "deleted", "=": null }],
        "from": "category",
        "limit": 1000
      }
    },
    {
      "name": "Category Tree",
      "process": "xiang.helper.ArrayTree",
      "args": ["{{$res.category}}", { "parent": "parent_id" }]
    }
  ],
  "output": "{{$res.category tree}}"
}

call 127.0.0.1/api/select/category