Skip to content

Commit 63db83d

Browse files
committed
docs: Обновлен README
1 parent 3f78cd4 commit 63db83d

File tree

1 file changed

+57
-18
lines changed

1 file changed

+57
-18
lines changed

README.md

Lines changed: 57 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@
99

1010
* 1\. [Установка](#installation)
1111
* 2\. [Использование](#usage)
12-
* 2.1\. [CLI приложение](#cli-app)
13-
* 2.2\. [Тестирование с asserts и 1connector](#testing)
14-
* 2.3\. [Swagger UI](#swagger-ui)
12+
* 2.1\. [CLI](#cli)
13+
* 2.2\. [Тестирование через OneUnit](#testing-oneunit)
14+
* 2.3\. [Тестирование через 1testrunner](#testing-1testrunner)
15+
* 2.4\. [Swagger UI](#swagger-ui)
1516
* 3\. [Совместимость](#compatibility)
1617
* 4\. [Программный интерфейс](#api)
1718
* 5\. [Пользовательские эндпоинты](#custom-endpoints)
@@ -26,24 +27,66 @@ opm install httpbin
2627

2728
## Использование <a name="usage"></a>
2829

29-
### CLI приложение <a name="cli-app"></a>
30+
### CLI <a name="cli"></a>
3031

3132
Запустите сервис с помощью команды:
3233

3334
``` bash
3435
httpbin run
3536
```
3637

38+
После запуска сервис будет доступен по адресу: `http://127.0.0.1:3333`
39+
3740
#### Опции команды:
3841

3942
| Опция | Описание | Значение по умолчанию |
4043
| --- | --- | --- |
4144
| `-h`, `--host` | Имя хоста или IP-адрес сервиса | `127.0.0.1` |
4245
| `-p`, `--port` | TCP-порт сервиса | `3333` |
43-
| `-r`, `--routes`, `--routes-handlers` | Путь к файлу или каталогу кастомных контроллеров | |
46+
| `-r`, `--routes`, `--routes-handlers` | Путь к файлу или каталогу с пользовательскими контроллерами | |
47+
48+
### Тестирование через [OneUnit](https://github.com/sfaqer/OneUnit) <a name="testing-oneunit"></a>
49+
50+
``` bsl
51+
# test.os
52+
53+
#Использовать asserts
54+
#Использовать 1connector
55+
#Использовать httpbin
56+
57+
Перем HttpBin;
4458
45-
### Тестирование с [asserts](https://github.com/oscript-library/asserts) и [1connector](https://github.com/vbondarevsky/1connector) <a name="testing"></a>
59+
&ТестовыйНабор(Характер = "Одиночка")
60+
Процедура ПриСозданииОбъекта()
61+
КонецПроцедуры
4662
63+
&ПередВсеми
64+
Процедура ПередЗапускомТестов() Экспорт
65+
HttpBin = Новый HttpBin();
66+
HttpBin.Запустить();
67+
КонецПроцедуры
68+
69+
&ПослеВсех
70+
Процедура ПослеЗапускаТестов() Экспорт
71+
HttpBin.Остановить();
72+
КонецПроцедуры
73+
74+
&Тест
75+
Процедура ТестДолжен_ПроверитьПараметрыЗапроса() Экспорт
76+
77+
ПараметрыЗапроса = Новый Структура();
78+
ПараметрыЗапроса.Вставить("key", "value");
79+
80+
Ответ = КоннекторHTTP.Get(HttpBin.URL("/get"), ПараметрыЗапроса);
81+
82+
Ожидаем.Что(Ответ.КодСостояния).Равно(200);
83+
Ожидаем.Что(Ответ.Заголовки["Content-Type"]).Содержит("application/json");
84+
Ожидаем.Что(Ответ.Json()["args"]["key"]).Равно("value");
85+
86+
КонецПроцедуры
87+
```
88+
89+
### Тестирование через [1testrunner](https://github.com/artbear/1testrunner) <a name="testing-1testrunner"></a>
4790

4891
``` bsl
4992
# test.os
@@ -86,7 +129,7 @@ httpbin run
86129

87130
## Совместимость <a name="compatibility"></a>
88131

89-
Сервис протестирован и поддерживается на следующих платформах и версиях OneScript:
132+
Поддерживаемые платформы и версии OneScript::
90133

91134
| ОС | OneScript 1.9 | OneScript 2.0 |
92135
| --- | --- | --- |
@@ -98,8 +141,8 @@ httpbin run
98141

99142
### Класс `HttpBin`
100143

101-
Класс предназначен для управления локальным HTTP-сервисом.
102-
Реализован с использованием текучего интерфейса.
144+
Класс предназначен для управления жизненным циклом локального HTTP-сервиса.
145+
Поддерживает текучий интерфейс (fluent API).
103146

104147
#### Синтаксис
105148

@@ -139,12 +182,10 @@ IP-адрес или имя хоста.</br>
139182

140183
## Пользовательские эндпоинты <a name="custom-endpoints"></a>
141184

142-
Сервис поддерживает подключение пользовательских контроллеров для добавления собственных эндпоинтов.
185+
Сервис поддерживает подключение пользовательских контроллеров.
143186

144-
### Создание контроллера
145-
146-
Контроллер реализуется в виде класса OneScript с аннотацией `&Контроллер`.
147-
В нём определяются точки маршрута (эндпоинты) с помощью аннотации `&ТочкаМаршрута`.
187+
Контроллер - это класс OneScript с аннотацией `&Контроллер`.
188+
В классе определяются точки маршрута (эндпоинты) аннотацией `&ТочкаМаршрута`.
148189
Подробнее см. в документации [WINOW](https://github.com/autumn-library/winow).
149190

150191
**Пример контроллера**
@@ -162,9 +203,7 @@ IP-адрес или имя хоста.</br>
162203

163204
### Подключение контроллеров
164205

165-
**Через программный интерфейс**
166-
167-
Для подключения кастомных контроллеров используйте метод `УстановитьРасположениеКонтроллеров()`, указав путь к файлу или каталогу с контроллерами:
206+
**Через API**
168207

169208
``` bsl
170209
HttpBin = Новый HttpBin()
@@ -175,7 +214,7 @@ HttpBin = Новый HttpBin()
175214
**Через CLI**
176215

177216
``` bash
178-
httpbin run --routes-handlers './path/to/routes-handlers'
217+
httpbin run --routes './path/to/routes'
179218
```
180219

181220
## Ограничения <a name="limitations"></a>

0 commit comments

Comments
 (0)