https://github.com/stivo182/oscript-httpbin
Cервис тестирования HTTP клиента разработанный на OneScript + WINOW
https://github.com/stivo182/oscript-httpbin
api http http-server httpbin oscript testing
Last synced: 6 months ago
JSON representation
Cервис тестирования HTTP клиента разработанный на OneScript + WINOW
- Host: GitHub
- URL: https://github.com/stivo182/oscript-httpbin
- Owner: Stivo182
- License: mit
- Created: 2025-01-22T12:14:04.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T08:50:21.000Z (6 months ago)
- Last Synced: 2025-04-02T09:36:09.127Z (6 months ago)
- Topics: api, http, http-server, httpbin, oscript, testing
- Language: 1C Enterprise
- Homepage:
- Size: 665 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oscript-httpbin
[](https://github.com/Stivo182/oscript-httpbin/releases)
[](https://github.com/stivo182/oscript-httpbin/actions/workflows/test.yml)
[](https://sonar.openbsl.ru/dashboard?id=httpbin)
[](https://sonar.openbsl.ru/dashboard?id=httpbin)
Cервис позволяющий локально тестировать HTTP клиент. Разработан на [OneScript](https://github.com/EvilBeaver/OneScript) + [WINOW](https://github.com/autumn-library/winow). Поддерживает бо́льшую часть эндпоинтов [httpbin.org](https://httpbin.org/).
* 1\. [Установка](#установка)
* 2\. [Использование](#использование)
* 2.1\. [Тестирование через asserts и 1connector](#тестирование-через-asserts-и-1connector)
* 2.2\. [Приложение на фреймворке autumn](#приложение-на-фреймворке-autumn)
* 2.3\. [CLI приложение](#cli-приложение)
* 2.4\. [Swagger UI](#swagger-ui)
* 3\. [Совместимость](#совместимость)
* 4\. [Программный интерфейс](#программный-интерфейс)
* 5\. [Ограничения](#ограничения)
* 6\. [Сравнение с httpbin.org](#сравнение-с-httpbinorg)
## Установка
``` bash
opm install httpbin
```
## Использование
### Тестирование через [asserts](https://github.com/oscript-library/asserts) и [1connector](https://github.com/vbondarevsky/1connector)
_test.os:_
``` bsl
#Использовать asserts
#Использовать 1connector
#Использовать httpbin
Перем HttpBin;
&Инициализация
Процедура ПередЗапускомТестов() Экспорт
HttpBin = Новый HttpBin();
HttpBin.Запустить();
КонецПроцедуры
&Завершение
Процедура ПослеЗапускаТестов() Экспорт
HttpBin.Остановить();
КонецПроцедуры
&Тест
Процедура ТестДолжен_ПроверитьПараметрыЗапроса() Экспорт
ПараметрыЗапроса = Новый Структура();
ПараметрыЗапроса.Вставить("key", "value");
Ответ = КоннекторHTTP.Get(HttpBin.URL() + "/get", ПараметрыЗапроса);
Ожидаем.Что(Ответ.КодСостояния).Равно(200);
Ожидаем.Что(Ответ.Заголовки["Content-Type"]).Содержит("application/json");
Ожидаем.Что(Ответ.Json()["args"]["key"]).Равно("value");
КонецПроцедуры
```
### Приложение на фреймворке [autumn](https://github.com/autumn-library/autumn)
_МойЖелудь.os:_
``` bsl
#Использовать 1connector
#Использовать httpbin
&Пластилин
Перем HttpBin;
Функция ВыполнитьДействие() Экспорт
HttpBin.Запустить();
Ответ = КоннекторHTTP.Get(HttpBin.URL() + "/get");
HttpBin.Остановить();
КонецФункции
&Желудь
Процедура ПриСозданииОбъекта()
КонецПроцедуры
```
### CLI приложение
Запуск сервиса через команду **run**: `httpbin run`
Опции команды:
`-h`, `--host` - имя хоста / IP адрес сервиса
`-p`, `--port` - порт сервиса
### Swagger UI
На стартовой странице сервиса (адрес по умолчанию: `http://127.0.0.1:3334`) доступна визуальная документация API, а также возможность отправки запросов и получения ответов.
## Совместимость
Windows
Linux
MacOS
OneScript 1.9
OneScript 2.0
OneScript 1.9
OneScript 2.0
OneScript 1.9
OneScript 2.0
✅
✅
✅
✅
✅
✅
## Программный интерфейс
### Класс `HttpBin`
Сервис по умолчанию запускается по адресу `127.0.0.1:3334` в фоновом режиме и с ожиданием завершения запуска сервиса.
Класс реализован с текучим интерфейсом.
| Метод | Описание |
| --- | --- |
| `Запустить()` | Запускает сервис |
| `Остановить()` | Останавливает сервис |
| `URL()` | URL сервиса |
| `Хост()` | Хост сервиса |
| `Порт()` | Порт сервиса |
| `УстановитьХост(<Хост>)` | Устанавливает хост сервиса |
| `УстановитьПорт(<Порт>)` | Устанавливает порт сервиса |
| `ЗапускатьВФоне(<Флаг>)` | Запуск сервиса будет выполнен в фоновом режиме |
| `ОжидатьЗапуск(<Флаг>)` | Ожидать завершение запуска сервиса, запущенного в фоновом режиме |
| `УстановитьТаймаутОжидания(<Таймаут>)` | Устанавливает таймаут ожидания запуска сервиса, запущенного в фоновом режиме |
## Ограничения
На данный момент нет поддержки https.
## Сравнение с httpbin.org
| Эндпоинт | oscript-httpbin | httpbin.org |
| --- | :-: | :-: |
| `/ip` | ✅ | ✅ |
| `/uuid` | ✅ | ✅ |
| `/uuid/:n` | ✅ | ❌ |
| `/user-agent` | ✅ | ✅ |
| `/headers` | ✅ | ✅ |
| `/get` | ✅ | ✅ |
| `/post` | ✅ | ✅ |
| `/put` | ✅ | ✅ |
| `/patch` | ✅ | ✅ |
| `/delete` | ✅ | ✅ |
| `/anything` | ✅ | ✅ |
| `/anything/:anything` | ✅ | ✅ |
| `/base64/:value` | ✅ | ✅ |
| `/encoding/utf8` | ✅ | ✅ |
| `/gzip` | ✅ | ✅ |
| `/deflate` | ✅ | ✅ |
| `/brotli` | ✅ | ✅ |
| `/zstd` | ✅ | ❌ |
| `/status/:code` | ✅ | ✅ |
| `/response-headers?key=val` | ✅ | ✅ |
| `/redirect/:n` | ✅ | ✅ |
| `/redirect-to?url=foo` | ✅ | ✅ |
| `/redirect-to?url=foo&status_code=307` | ✅ | ✅ |
| `/relative-redirect/:n` | ✅ | ✅ |
| `/absolute-redirect/:n` | ✅ | ✅ |
| `/cookies` | ✅ | ✅ |
| `/cookies/set?name=value` | ✅ | ✅ |
| `/cookies/set/:name/:value` | ✅ | ✅ |
| `/cookies/delete?name` | ✅ | ✅ |
| `/basic-auth/:user/:passwd` | ✅ | ✅ |
| `/hidden-basic-auth/:user/:passwd` | ✅ | ✅ |
| `/digest-auth/:qop/:user/:passwd/:algorithm` | ❌ | ✅ |
| `/digest-auth/:qop/:user/:passwd` | ❌ | ✅ |
| `/bearer` | ✅ | ✅ |
| `/stream/:n` | ❌ | ✅ |
| `/delay/:n` | ✅ | ✅ |
| `/drip?numbytes=n&duration=s&delay=s&code=code` | ❌ | ✅ |
| `/range/:n?duration=s&chunk_size=code` | ❌ | ✅ |
| `/html` | ✅ | ✅ |
| `/robots.txt` | ✅ | ✅ |
| `/deny` | ✅ | ✅ |
| `/cache` | ✅ | ✅ |
| `/cache/:n` | ✅ | ✅ |
| `/etag/:etag` | ✅ | ✅ |
| `/bytes/:n` | ✅ | ✅ |
| `/stream-bytes/:n` | ❌ | ✅ |
| `/links/:n` | ✅ | ✅ |
| `/links/:n/:offset` | ✅ | ✅ |
| `/image` | ✅ | ✅ |
| `/image/png` | ✅ | ✅ |
| `/image/jpeg` | ✅ | ✅ |
| `/image/webp` | ✅ | ✅ |
| `/image/svg` | ✅ | ✅ |
| `/forms/post` | ✅ | ✅ |
| `/xml` | ✅ | ✅ |
| `/json` | ✅ | ✅ |