Перейти к содержимому

Начало работы

  1. Установите CLI (Linux):

    Окно терминала
    curl -fsSL https://raw.githubusercontent.com/1rowvy/outry/master/install.sh | sh

    Приложение и другие платформы — в разделе Установка.

  2. Создайте проект в своём репозитории:

    Окно терминала
    cd my-service
    outry init

    Появятся api/env.toml с окружениями dev и prod и пример запроса api/health.outry.

  3. Укажите адрес API в api/env.toml:

    api/env.toml
    default = "dev"
    [env.dev]
    base = "http://localhost:8080"
    [env.prod]
    base = "https://api.example.com"
  4. Напишите запрос. Имя пишется перед методом, путь дописывается к base:

    api/users/list.outry
    ListUsers: GET /users {
    query { page: 1 }
    expect {
    status == 200
    body.items.length > 0
    }
    }

    Самый короткий запрос — одна строка: GET /health.

  5. Запустите:

    Окно терминала
    outry run api/users/list.outry
    outry run ListUsers # по имени
    outry run api # все *.outry и *.http внутри api/ по алфавиту
    outry run api --env prod # другое окружение
    ✓ api/users/list.outry ListUsers GET http://localhost:8080/users?page=1 200 OK 12ms 532B
    ✓ status == 200
    ✓ body.items.length > 0

Есть сервис на Go? outry import go . создаст запрос для каждого роута chi, gin или net/http, а outry check потом подскажет, когда код и запросы разойдутся, — см. Импорт роутов из Go.

Уже есть .http-файлы? outry convert api/ перепишет их в .outry — см. Файлы .http.