|
1 | 1 | # swagger-typescript-api |
2 | 2 |
|
3 | | -<img |
4 | | - src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png" |
5 | | - title="swagger-typescript-api logo by js2me" |
6 | | - align="left" |
7 | | - height="180" |
8 | | - width="93" |
9 | | -/> |
| 3 | +- Support OpenAPI 3.0, 2.0, JSON, YAML |
| 4 | +- Generate API via swagger scheme |
| 5 | +- Generate API module use [**Fetch**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests |
10 | 6 |
|
11 | | -- Generate api via swagger scheme |
12 | | -- Supports OA 3.0, 2.0, JSON, yaml |
13 | | -- Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests. |
| 7 | +Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/discussions) |
14 | 8 |
|
15 | | -<br> |
| 9 | +## Examples |
16 | 10 |
|
17 | | -Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/issues) or in [**our Slack**](https://join.slack.com/t/acacode/shared_invite/enQtOTQ5ODgyODQzMzYwLWYxOGI1MzQ3Yzg1ZWI5ZTI5NzNiZjExZTE5OWI1YjQ4NjBiNTk4NWVlNjM5YmU1ZWI2ZDkyMzZkZGIxNjA5NTQ)(**#swagger-typescript-api** channel) |
| 11 | +All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/main/tests) |
18 | 12 |
|
19 | | - |
20 | | - |
21 | | -Thanks to [JetBrains](https://www.jetbrains.com/?from=swaggertypescriptapi) for providing a free license for their excellent Webstorm IDE. |
22 | | - |
23 | | -## 👀 Examples |
24 | | - |
25 | | -All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/master/tests) |
26 | | - |
27 | | -## 📄 Usage |
| 13 | +## Usage |
28 | 14 |
|
29 | 15 | ```muse |
30 | 16 | Usage: sta [options] |
@@ -203,7 +189,7 @@ generateTemplates({ |
203 | 189 | }); |
204 | 190 | ``` |
205 | 191 |
|
206 | | -## 💎 options |
| 192 | +## Options |
207 | 193 |
|
208 | 194 | ### **`--templates`** |
209 | 195 |
|
@@ -487,21 +473,13 @@ generateApi({ |
487 | 473 |
|
488 | 474 | See more about [swagger schema type/format data here](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times) |
489 | 475 |
|
490 | | -## 📄 Mass media |
| 476 | +## Mass media |
491 | 477 |
|
492 | 478 | - [5 Lessons learned about swagger-typescript-api](https://christo8989.medium.com/5-lessons-learned-about-swagger-typescript-api-511240b34c1) |
493 | 479 | - [Why Swagger schemes are needed in frontend development ?](https://dev.to/js2me/why-swagger-schemes-are-needed-in-frontend-development-2cb4) |
494 | 480 | - [Migration en douceur vers TypeScript (French)](https://www.premieroctet.com/blog/migration-typescript/) |
495 | 481 | - [swagger-typescript-api usage (Japanese)](https://zenn.dev/watahaya/articles/2f4a716c47903b) |
496 | 482 |
|
497 | | -## 🚀 How it looks |
498 | | - |
499 | | - |
500 | | - |
501 | | - |
502 | | - |
503 | | - |
504 | | - |
505 | | -## 📝 License |
| 483 | +## License |
506 | 484 |
|
507 | | -Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/master/LICENSE). |
| 485 | +Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/main/LICENSE). |
0 commit comments