ДокументацияСоглашения и концепции
Глоссарий
Слова, используемые в этих документах, по одной строке в алфавитном порядке. У термина, которому нужно больше, чем строка, есть страница: перейдите по ссылке. О том, как эти понятия соотносятся друг с другом, читайте в Основные понятия.
Условия
| Термин | В одну строку |
|---|---|
| Действие | функция Python с пометкой @Action, служащая как POST и вызываемая с клиента (действия) |
| ASGI | говорит интерфейс Uvicorn, реализованный FastAPI и Starlette |
| Клиентский режим | useCSR = True: файлы фреймворка - это маршруты и навигация браузера (режимы) |
| Компонент | повторно используемый строительный блок пользовательского интерфейса, используемый для составления представления (представления) |
| CSR | рендеринг на стороне клиента: браузер отображает страницы после первого документа (CSR) |
| Зависимость | функция FastAPI выполняется перед обработчиком, для каждого маршрута или для каждой папки (зависимости) |
| Оболочка документа | <html>, <head> и <body> вокруг страницы, принадлежащей ближайшему макету или Nexy (макеты) |
| Конечная точка | уникальная комбинация URL-адреса и метода HTTP (представления) |
| Маршрутизация на основе файлов FBR | : файл в папке src/routes/ является маршрутом (маршрутизация) |
| Frontmatter | блок Python между двумя строками --- файла .nexy или .md (файлы .nexy) |
| Guard | зависимость, которая отклоняет запрос путем поднятия HTTPException (гарды) |
| Обработчик | функция Python, которая обрабатывает HTTP-запрос для определенного метода (представления) |
| HMR | горячая замена модулей: сервер разработки меняет местами измененные модули без полной перезагрузки (фронтенд) |
| Гидратация | браузер, прикрепляющий фреймворк к уже отправленному сервером HTML (острова) |
| Остров | клиентский компонент, смонтированный внутри страницы, отображаемой сервером (острова) |
| ISR | инкрементная статическая регенерация: одна кэшированная страница на каждый путь, обновляемая в фоновом режиме (ISR) |
| Макет | файл layout.*, в который переплетаются страницы, находящиеся под его папкой (макеты) |
| Маршруты модульного маршрутизатора | объявлены с помощью @Module и @Controller в src/apps/ (модульный) |
| Страница | ресурс с URL-адресом, определенный файлом в папке src/routes/ (представления) |
| Предварительная выборка | загрузка страницы после ссылки до того, как читатель нажмет на нее (ссылки) |
| Реквизит | значения, которые родитель передает компоненту (.nexy файлы) |
| Повторно проверить | количество секунд, после которых страница ISR перестраивается в фоновом режиме (ISR) |
| Маршрутизация | шаблона URL-адреса, созданного путем пути к файлу маршрута (маршрутизация) |
| Группа маршрутов | папка в скобках, которая группирует маршруты без добавления сегмента (динамические маршруты) |
| Обработчик маршрута | функция GET, POST, … файла маршрута .py (обработчики) |
| Режим сервера | useCSR = False, по умолчанию: сервер отображает страницы .nexy и .md (режимы) |
| Навык | папка с SKILL.md, которая обучает агента кодирования одной части Nexy (агенты кодирования) |
| SSG | создание статического сайта; не режим Nexy: заранее созданный HTML всегда считывается сервером (рендеринг) |
| SSR | рендеринг на стороне сервера: сервер отображает каждую страницу по его запросу, и это значение по умолчанию (SSR) |
| Просмотрите | процесс создания тела ответа для страницы (представления) |
Файлы и папки
| Имя | В одну строку |
|---|---|
__nexy__/ |
сгенерированный вывод: скомпилированные страницы, запись клиента и клиент действия; никогда не редактировался, никогда не фиксировался |
nexyconfig.py |
конфигурация проекта, класс use* полей (конфигурация) |
public/ |
файлы, обслуживаемые в корне, например public/logo.svg → /logo.svg (условия файлов) |
src/apps/ |
контроллеры и модули модульного маршрутизатора (модульный) |
src/components/ |
компоненты, импортированные по страницам; никогда не маршрутизирует (соглашения о файлах) |
src/routes/ |
маршруты приложения (соглашения о файлах) |
Следующие шаги
- Основные понятия: модель, к которой принадлежат эти слова
- Указатель документации: страница для текущей задачи.
- Соглашения о файлах: зарезервированные имена, стоящие за этими определениями.
- Для ИИ-агентов: те же инварианты, написанные для агента