45 lines
2.2 KiB
Markdown
45 lines
2.2 KiB
Markdown
# Генератор приложений
|
||
|
||
Утилита предназначена для генерирования некоторых частей кода на основе файла с описанием для облегчения и ускорения написания приложений.
|
||
|
||
Дополнительный компонент:
|
||
|
||
```
|
||
go install github.com/swaggo/swag/cmd/swag@latest
|
||
```
|
||
|
||
# Angular
|
||
|
||
## Генератор
|
||
|
||
```bash
|
||
wget https://oss.sonatype.org/content/repositories/releases/io/swagger/swagger-codegen-cli/3.0.46/swagger-codegen-cli-3.0.46.jar
|
||
```
|
||
|
||
## Файл опций для генерации
|
||
|
||
```json
|
||
{
|
||
"ngVersion": "16.1.4"
|
||
}
|
||
```
|
||
|
||
## Генерирование
|
||
|
||
```bash
|
||
java -jar swagger-codegen-cli-2.4.32.jar generate -i docs/swagger.json -l typescript-angular -o angular/service -c options.json
|
||
```
|
||
|
||
Описание функций берется из файла json сервера.
|
||
|
||
## Предустановленные списки
|
||
|
||
В каждой таблице могут быть предустановленные данные (values). Такие данные являются константными, т.е. во время миграции все бредыдущие записи будут удалены и созданы новые. Все значения справочника подразумеваются как строковые, а генерируемы индетификатор может быть подставлен только UUID. Имена полей должны совпадать.
|
||
|
||
# REST
|
||
|
||
Если в пути указаны параметры, например */geocoder/tile/:z/:y:x*, то *z*, *x* и *y* являются переменными и они вставляются в параметры path. Все что дальше идет по пути оставляется как есть, а директория в route формируется до переменных и, как в примере, имеет вид *geocoder/tile*
|
||
|
||
## data.name
|
||
|
||
Если указана binary, то клиенту возвращаются двоичные данные независимо от других условий (картинки, документы и т.д.) |