Skip to content

Commit fc29191

Browse files
docs: update readme
1 parent b93d87a commit fc29191

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

.changeset/gold-brooms-raise.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'openapi-ts-request': patch
3+
---
4+
5+
docs: update readme

README-en_US.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ English | <a href="https://github.com/openapi-ui/openapi-ts-request/blob/master/
66

77
Generate TS interfaces, request client, request mock service, enum, type field label, JSON Schemas based on [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) specification
88

9+
文档:[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
10+
911
## Features
1012

1113
- support Swagger2.0/OpenAPI 3.0,3.1 specification
@@ -207,7 +209,7 @@ currently using [mockjs](http://mockjs.com) to generate mock data, the mocks fil
207209

208210
## Adapt to uniapp
209211

210-
it is recommended to use a custom request function to adapt to uniapp. you can also use the `@uni-helper/axios-adapter` adapter. for details, see [issue#46](https://github.com/openapi-ui/openapi-ts-request/issues/46)
212+
it is recommended to use a custom request function to adapt to uniapp. you can also use the `@uni-helper/axios-adapter` adapter. for details, see [【use docs 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
211213

212214
## Contribute
213215

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 TS 类型, 客户端请求函数, 模拟请求响应服务, 枚举, 类型字段翻译, JSON Schemas
88

9+
文档:[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
10+
911
## 功能
1012

1113
- 支持 Swagger2.0/OpenAPI 3.0,3.1 定义
@@ -207,7 +209,7 @@ export declare function patchSchema<T extends object>(
207209

208210
## 适配uniapp
209211

210-
适配 uniapp 推荐采用自定义 request 函数的方式,你也可以使用 `@uni-helper/axios-adapter` 适配器,详情见 [issue#46](https://github.com/openapi-ui/openapi-ts-request/issues/46)
212+
适配 uniapp 推荐采用自定义 request 函数的方式,你也可以使用 `@uni-helper/axios-adapter` 适配器,详情见 [【使用手册 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
211213

212214
## 贡献
213215

0 commit comments

Comments
 (0)