AutoBE
    Preparing search index...

    Interface IEndpoint

    API endpoint information.

    interface IEndpoint {
        method: "get" | "post" | "put" | "delete" | "patch";
        path: string & Pattern<"^\\/[a-zA-Z0-9\\/_{}.-]*$">;
    }

    Hierarchy (View Summary)

    Index

    Properties

    method path

    Properties

    method: "get" | "post" | "put" | "delete" | "patch"

    HTTP method (lowercase only).

    Use patch (not get) when a read operation needs a complex requestBody. get cannot have a request body.

    path: string & Pattern<"^\\/[a-zA-Z0-9\\/_{}.-]*$">

    HTTP path of the API operation.

    Must start with /. Parameters use curly braces: {paramName}. Resource names in camelCase. No quotes, spaces, role prefixes (/admin/), or API version prefixes (/api/v1/).

    Allowed characters: letters, digits, /, {, }, -, _, .

    Settings

    Member Visibility

    On This Page

    Properties