Skip to content
Membrane

HTTP Endpoints

Every Membrane program has its own URL and can handle requests made to that URL. This provides a simple mechanism for calling into your membrane programs from the outside world.

export const 
const endpoint: (req: {
    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
    path: string;
    body?: string;
    query?: string;
    headers: string;
}) => string
endpoint: resolvers.interface resolvers.RootRoot["endpoint"] = (
req: {
    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
    path: string;
    body?: string;
    query?: string;
    headers: string;
}
req) => {
  switch (`${
req: {
    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
    path: string;
    body?: string;
    query?: string;
    headers: string;
}
req.method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS"method} ${
req: {
    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
    path: string;
    body?: string;
    query?: string;
    headers: string;
}
req.path: stringpath}`) {
    case "GET /":
      return "hello world";
    default:
      return var JSON: JSON
An intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.
JSON.JSON.stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string (+1 overload)
Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
@paramvalue A JavaScript value, usually an object or array, to be converted.@paramreplacer A function that transforms the results.@paramspace Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
stringify({ status: numberstatus: 404 });
  }
};

Accessing an endpoint URL

To access a program’s endpoint URL in your code, call await nodes.process.endpointUrl.

You can also copy a program’s endpoint by right clicking on it in the Navigator panel. When your program endpoint receives a request it will be logged, so you can inspect it in the Logs panel.