Skip to content

Commit 2f4cb2d

Browse files
committed
Update README.md
Signed-off-by: Sora Morimoto <[email protected]>
1 parent 2037e56 commit 2f4cb2d

7 files changed

+13
-35
lines changed

README.md

+11-33
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,16 @@
11
# swagger-typescript-api
22

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
106

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)
148

15-
<br>
9+
## Examples
1610

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)
1812

19-
![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/components-converter-example.jpg)
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
2814

2915
```muse
3016
Usage: sta [options]
@@ -203,7 +189,7 @@ generateTemplates({
203189
});
204190
```
205191

206-
## 💎 options
192+
## Options
207193

208194
### **`--templates`**
209195

@@ -487,21 +473,13 @@ generateApi({
487473

488474
See more about [swagger schema type/format data here](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times)
489475

490-
## 📄 Mass media
476+
## Mass media
491477

492478
- [5 Lessons learned about swagger-typescript-api](https://christo8989.medium.com/5-lessons-learned-about-swagger-typescript-api-511240b34c1)
493479
- [Why Swagger schemes are needed in frontend development ?](https://dev.to/js2me/why-swagger-schemes-are-needed-in-frontend-development-2cb4)
494480
- [Migration en douceur vers TypeScript (French)](https://www.premieroctet.com/blog/migration-typescript/)
495481
- [swagger-typescript-api usage (Japanese)](https://zenn.dev/watahaya/articles/2f4a716c47903b)
496482

497-
## 🚀 How it looks
498-
499-
![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/npx.gif)
500-
501-
![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/auth-example.gif)
502-
503-
![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/typings1.gif)
504-
505-
## 📝 License
483+
## License
506484

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).

assets/auth-example.gif

-4.8 MB
Binary file not shown.
-63.8 KB
Binary file not shown.

assets/npx.gif

-319 KB
Binary file not shown.
-13.9 KB
Binary file not shown.

assets/typings1.gif

-3.71 MB
Binary file not shown.

templates/base/http-client.ejs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<% const { config } = it; %>
2-
<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
3-
<%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>
2+
<% /* https://github.com/acacode/swagger-typescript-api/tree/main/templates/base/http-clients/ */ %>
3+
<%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>

0 commit comments

Comments
 (0)