meta.md

Meta Tools

Lightning Server comes with a bunch of easy tools for working with your server.

You can enable them just like this:

object Server : ServerPathGroup(ServerPath.root) {
    val meta = path("meta").metaEndpoints<User>(
        // We only let admins access some tools, like the metrics and health endpoints.
        isAdmin = { it: User -> it.email.endsWith("@lightningkite.com") }
    )
}

Now, if you visit your server's /meta page, you'll have access to several convenient tools.

/meta/docs

Some plain text documentation for all of your typed endpoints and their associated types.

Also contains a link to get SDKs for several programming languages.

/meta/health

A JSON-returning endpoint that will report the health status of your system, including memory usage, load, and health statuses for each individual dependent system such as caches, database, files, and emails.

/meta/online

Simply returns the plain-text 200 response "Server is running." Can be useful for quick checks.

/meta/admin

A React-driven administrative panel that allows for management of any models you've exposed RESTful endpoints for, as well as testers for your endpoints.

/meta/openapi

Automatically-generated Swagger docs.

/meta/openapi.json

Automatically-generated OpenAPI JSON spec.

/meta/schema

Returns a Lightning Server specific schema in JSON.

/meta/paths

Returns a list of all paths that the server responds to, as well as all tasks, schedules, and more.

/meta/ws-tester

A convenient web socket tester.