HTTP

A Jadpo app answers HTTP requests with routes. A route says which method and URL it answers, what comes in, what goes out, and which action or query runs. This route adds a todo:

domains/todos/routes/todos.jadpo:

use todos/types { NewTodo, TodoView }use todos/actions { add_todo }/// The todo list.routes Todos {    prefix: /todos    /// Adds a todo.    POST / {        authentication: RouteAuthentication.none        input: NewTodo        output: TodoView        run: add_todo(input)    }}

It answers POST /todos. Jadpo reads a NewTodo from the JSON body and checks it, and run: gets it as input. run: calls the action add_todo, which returns a TodoView, the route's output:. The route answers 200 with that value as JSON.

NewTodo, TodoView and add_todo are your app's own. Each use line brings a name in from another file of your app, and these are the files:

domains/todos/types/new_todo.jadpo:

/// What a caller sends to add a todo.type NewTodo = Input {    title: Text}

domains/todos/types/todo_view.jadpo:

/// A todo, as the app sends it back.type TodoView = Output {    title: Text    done: Bool}

domains/todos/actions/add_todo.jadpo:

use todos/types { NewTodo, TodoView }/// Builds the todo and sends it back. It stores nothing.action add_todo(input: NewTodo) -> TodoView {    return TodoView {        title: input.title        done: false    }}

policy.jadpo:

use todospolicy {    actions: {        todos.add_todo: [Access.public]    }}

Most actions take their permission from the stored records they reach (Policy). add_todo reaches none, so policy.jadpo says who may run it, and Access.public means anyone. RouteAuthentication, Access, Text and Bool are built into Jadpo, so they need no use line.

Every route needs a signed-in caller unless an authentication: line in the route says otherwise, as this one does because the app has no sign-in yet (Routes: signed in by default).

Run jadpo api update once, which writes the public API record, then jadpo dev, and send it a todo:

curl -X POST http://localhost:3000/todos \  -H 'content-type: application/json' \  -d '{"title": "Buy milk"}'

{"title":"Buy milk","done":false}

A route holds no logic of its own. The work lives in actions and queries. When an action fails, the HTTP status comes from the failure's kind, a category such as not_found (404), never from the route (Failure kinds).

The topics of this page cover:

• how routes are grouped and matched: Route groups and Paths and placeholders;
• what a route reads and answers: One input and Output and status;
• how long it may run: Time limits;
• what Jadpo writes for you: Health checks, Generated routes, an OpenAPI document for each API, and The public API record, a file in your project that lists each API's routes and fields, so every change to the API shows as a diff of that file.

What is built says which of this works today.