Skip to content

Commit 2b2a1c4

Browse files
committed
docs: Улучшения в документации
1 parent 8bdc6a6 commit 2b2a1c4

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Тестирование](https://github.com/stivo182/oscript-httpbin/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/stivo182/oscript-httpbin/actions/workflows/test.yml)
55
[![Статус порога качества](https://sonar.openbsl.ru/api/project_badges/measure?project=httpbin&metric=alert_status&token=sqb_2f7c84743fd1b295085c25a1b96cc8d975cd4dc7)](https://sonar.openbsl.ru/dashboard?id=httpbin)
66

7-
Локальный сервис для тестирования и отладки HTTP-запросов, реализованный на [OneScript](https://github.com/EvilBeaver/OneScript) с использованием библиотеки [WINOW](https://github.com/autumn-library/winow).
7+
Локальный сервис для тестирования и отладки HTTP-запросов, реализованный на [OneScript](https://github.com/EvilBeaver/OneScript) с использованием фреймворка [WINOW](https://github.com/autumn-library/winow).
88
Проект предоставляет функциональность, аналогичную [httpbin.org](https://httpbin.org/), поддерживая большинство оригинальных эндпоинтов.
99

1010
* 1\. [Установка](#installation)
@@ -134,16 +134,18 @@ IP-адрес или имя хоста.</br>
134134
| `URL(<АдресРесурса>)` | Формирует полный URL-адрес сервиса с опциональным путем к ресурсу. |
135135
| `ТаймаутЗапуска()` | Возвращает текущее значение таймаута запуска сервиса. |
136136
| `УстановитьТаймаутЗапуска(<Таймаут>)` | Устанавливает максимальное время ожидания запуска сервиса. Применяется при синхронном запуске. |
137-
| `РасположениеКонтроллеров()` | Возвращает текущий путь к папке или файлу с кастомными контроллерами. |
138-
| `УстановитьРасположениеКонтроллеров(<Расположение>)` | Устанавливает путь к папке или файлу с кастомными контроллерами, определяющими маршруты сервиса. |
137+
| `РасположениеКонтроллеров()` | Возвращает текущий путь к файлу или каталогу с кастомными контроллерами. |
138+
| `УстановитьРасположениеКонтроллеров(<Расположение>)` | Устанавливает путь к файлу или каталогу с кастомными контроллерами, определяющими точки маршрута сервиса. |
139139

140140
## Кастомные эндпоинты <a name="custom-endpoints"></a>
141141

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

144144
### Создание контроллера
145145

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

148150
**Пример контроллера**
149151

@@ -162,7 +164,7 @@ IP-адрес или имя хоста.</br>
162164

163165
**Через программный интерфейс**
164166

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

167169
``` bsl
168170
HttpBin = Новый HttpBin()
@@ -173,7 +175,7 @@ HttpBin = Новый HttpBin()
173175
**Через CLI**
174176

175177
``` bash
176-
httpbin run --routes-handlers './path/to/routes'
178+
httpbin run --routes-handlers './path/to/routes-handlers'
177179
```
178180

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

src/core/Классы/HttpBin.os

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Перем _ТаймаутПроверки; // Число - Таймаут HTTP-проверки доступности в секундах
1010
Перем _ИмяХоста; // Строка - IP-адрес или доменное имя хоста
1111
Перем _Порт; // Число - Номер TCP-порта сервиса
12-
Перем _РасположениеКонтроллеров; // Строка, Неопределено - Путь к папке или файлу с кастомными контроллерами
12+
Перем _РасположениеКонтроллеров; // Строка, Неопределено - Путь к файлу или каталогу с кастомными контроллерами
1313
Перем _Процесс; // Процесс, Неопределено - Объект запущенного процесса
1414
Перем _Лог; // Лог - Логгер для отладочной информации
1515

@@ -198,10 +198,10 @@
198198
Возврат _ТаймаутЗапуска;
199199
КонецФункции
200200

201-
// Устанавливает путь к папке или файлу с кастомными контроллерами, определяющими маршруты сервиса.
201+
// Устанавливает путь к файлу или каталогу с кастомными контроллерами, определяющими точки маршрута сервиса.
202202
//
203203
// Параметры:
204-
// Расположение - Строка - Путь к папке или файлу с контроллерами (например, "./controllers" или "./МойКонтроллер.os")
204+
// Расположение - Строка - Путь к файлу или каталогу с контроллерами
205205
//
206206
// Возвращаемое значение:
207207
// ЭтотОбъект - Для возможности цепочки вызовов
@@ -211,7 +211,7 @@
211211
Возврат ЭтотОбъект;
212212
КонецФункции
213213

214-
// Возвращает текущий путь к папке или файлу с кастомными контроллерами.
214+
// Возвращает текущий путь к файлу или каталогу с кастомными контроллерами.
215215
//
216216
// Возвращаемое значение:
217217
// Строка, Неопределено

0 commit comments

Comments
 (0)