Source handlers

Source handlers allow you to define sources, such as APIs, that provide data to your mesh. Each handler in your mesh corresponds to an API or other source that you can specify. API Mesh for Adobe Developer App Builder currently supports the following handlers:

Whenever a schema is modified, you must update your mesh to allow API Mesh to cache any changes.

Only alphanumerical characters are allowed in source handler names.

Whenever a source schema is modified, you must update your mesh to allow API Mesh to cache any changes.

The following example contains a basic mesh file with an OpenAPI source handler.

{
  "meshConfig": {
    "sources": [
      {
        "name": "CommerceREST",
        "handler": {
          "openapi": {
            "source": "your_Commerce_API"
          }
        },
      }
    ]
  },
}
Copied to your clipboard
{
  "meshConfig": {
    "sources": [
      {
        "name": "CommerceREST",
        "handler": {
          "openapi": {
            "source": "your_Commerce_API"
          }
        },
      }
    ]
  },
}

Handlers are located in the sources section of the mesh file. Each source will need a name, a handler, and other key-value pairs that correspond to the handler type. In the previous example, the openapi handler only requires a source.

name - an alphanumeric name to distinguish between other handlers
handler- the type of handler you want to use, for example openapi
Handler specific data - the key-value pairs that correspond to your specified handler

Reference local files in handlers

To reference files directly, refer to local development.

You can reference local files as sources in handlers using the following format:

{
    "meshConfig": {
        "sources": [
            {
                "name": "CommerceREST",
                "handler": {
                    "openapi": {
                        "source": "your_Commerce_API"
                    }
                }
            },
            {
                "name": "CommerceRESTV2",
                "handler": {
                    "openapi": {
                        "source": "./CommerceRestV2.json"
                    }
                }
            }
        ],
        "files": [
            {
                "path": "./CommerceRestV2.json",
                "content": <LOCAL_FILE_CONTENT>
            }
        ]
    }
}
Copied to your clipboard
{
    "meshConfig": {
        "sources": [
            {
                "name": "CommerceREST",
                "handler": {
                    "openapi": {
                        "source": "your_Commerce_API"
                    }
                }
            },
            {
                "name": "CommerceRESTV2",
                "handler": {
                    "openapi": {
                        "source": "./CommerceRestV2.json"
                    }
                }
            }
        ],
        "files": [
            {
                "path": "./CommerceRestV2.json",
                "content": <LOCAL_FILE_CONTENT>
            }
        ]
    }
}