@gromlab/api-codegen 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Gromlab
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,114 @@
1
+ # API CodeGen
2
+
3
+ CLI утилита для генерации TypeScript API клиента из OpenAPI спецификации.
4
+
5
+ ## Установка
6
+
7
+ ```bash
8
+ bun install
9
+ ```
10
+
11
+ ## Использование
12
+
13
+ ```bash
14
+ api-codegen -u <URL> -i <INPUT> -o <OUTPUT> [-n <NAME>]
15
+ ```
16
+
17
+ **Аргументы:**
18
+ - `-u, --url <url>` - Базовый URL API
19
+ - `-i, --input <path>` - Путь к OpenAPI файлу (локальный или URL)
20
+ - `-o, --output <path>` - Директория для сохранения файлов
21
+ - `-n, --name <name>` - Имя сгенерированного файла (опционально)
22
+
23
+ **Примеры:**
24
+
25
+ ```bash
26
+ # Локальный файл
27
+ api-codegen -u https://api.example.com -i ./openapi.json -o ./src/api
28
+
29
+ # URL на спецификацию
30
+ api-codegen -u https://api.example.com -i https://petstore.swagger.io/v2/swagger.json -o ./src/api
31
+
32
+ # С кастомным именем файла
33
+ api-codegen -u https://api.example.com -i ./openapi.json -o ./src/api -n MyApiClient
34
+ ```
35
+
36
+ ## Пример использования
37
+
38
+ ```typescript
39
+ import { Api, HttpClient } from './src/api/Api';
40
+
41
+ const httpClient = new HttpClient();
42
+ httpClient.setSecurityData({ token: 'jwt-token' });
43
+
44
+ const api = new Api(httpClient);
45
+
46
+ // GET запрос
47
+ const user = await api.auth.getProfile();
48
+
49
+ // POST запрос
50
+ const result = await api.auth.login({ email, password });
51
+
52
+ // React + SWR
53
+ function Profile() {
54
+ const { data } = useSWR('/auth/me', () => api.auth.getProfile());
55
+ return <div>{data?.email}</div>;
56
+ }
57
+ ```
58
+
59
+ ## Разработка
60
+
61
+ ### Сборка
62
+ ```bash
63
+ bun run build
64
+ ```
65
+
66
+ ### Тестирование
67
+
68
+ Проект использует комплексную систему тестирования с максимальным покрытием (~72 тестовых кейса).
69
+
70
+ **Запуск всех тестов:**
71
+ ```bash
72
+ bun test
73
+ ```
74
+
75
+ **Только юнит тесты:**
76
+ ```bash
77
+ bun test:unit
78
+ ```
79
+
80
+ **Только интеграционные тесты:**
81
+ ```bash
82
+ bun test:integration
83
+ ```
84
+
85
+ **Watch режим:**
86
+ ```bash
87
+ bun test:watch
88
+ ```
89
+
90
+ **С coverage:**
91
+ ```bash
92
+ bun test:coverage
93
+ ```
94
+
95
+ Подробная документация по тестированию доступна в [`tests/README.md`](tests/README.md).
96
+
97
+ ### Структура тестов
98
+
99
+ - **Юнит тесты** - CLI, генератор, утилиты, валидация
100
+ - **Интеграционные тесты** - E2E генерация, сгенерированный клиент
101
+ - **Тестовые фикстуры** - 7 OpenAPI спецификаций для различных сценариев
102
+ - **Mock сервер** - для тестирования HTTP запросов
103
+
104
+ **Покрываемые сценарии:**
105
+ - ✅ CLI команды и обработка ошибок
106
+ - ✅ Генерация TypeScript кода
107
+ - ✅ Компиляция сгенерированного кода
108
+ - ✅ HTTP запросы с mock сервером
109
+ - ✅ Аутентификация (Bearer tokens)
110
+ - ✅ Edge cases (Unicode, большие спецификации)
111
+
112
+ ## Лицензия
113
+
114
+ MIT
Binary file