From 82c5fee89ebd45768e4f09f54f5c23cadc6e8a45 Mon Sep 17 00:00:00 2001 From: Josper Date: Mon, 6 May 2024 17:06:35 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20fix=20link=20path?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guide/advance/response-type.md | 2 +- docs/guide/changelog.md | 50 +++++++++++++++++++ docs/guide/examples.md | 2 +- docs/guide/getting-started.md | 2 +- docs/intro/middleware.md | 4 +- docs/reference/interface-middleware-common.md | 2 +- docs/reference/interface-service.md | 2 +- 7 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 docs/guide/changelog.md diff --git a/docs/guide/advance/response-type.md b/docs/guide/advance/response-type.md index ecb7711..21efcb9 100644 --- a/docs/guide/advance/response-type.md +++ b/docs/guide/advance/response-type.md @@ -1,6 +1,6 @@ # 设置响应数据解析类型 -由于默认解析类型为json，但有些接口返回的不是json格式，我们提供了以下方法，参考[内置中间件-ResData](../reference/interface-middleware-builtin.md) +由于默认解析类型为json，但有些接口返回的不是json格式，我们提供了以下方法，参考[内置中间件-ResData](../../reference/interface-middleware-builtin.md) ```ts import { HttpService, BUILT_IN_MIDDLEWARE } from 'http-svc' diff --git a/docs/guide/changelog.md b/docs/guide/changelog.md new file mode 100644 index 0000000..0c756f2 --- /dev/null +++ b/docs/guide/changelog.md @@ -0,0 +1,50 @@ +# CHANGELOG + + + +## [v1.0.0-rc.7] - 2024-04-18 + +### Added + +- Bundle update + +## [v1.0.0-rc.6] - 2024-03-19 + +### Added + +- Types update + +### Fixed + +- AssembleCtrl compose bug + +## [v1.0.0-rc.1] - 2024-01-11 + +### Added + +- Release RC version diff --git a/docs/guide/examples.md b/docs/guide/examples.md index df14a57..a28f8f2 100644 --- a/docs/guide/examples.md +++ b/docs/guide/examples.md @@ -30,7 +30,7 @@ const httpSvc = new HttpService() ## NodeJS 环境使用 -本节的API参考见 [服务端环境常用中间件](../guide/reference/npm-server-fetch) +本节的API参考见 [服务端环境常用中间件](../reference/npm-server-fetch) 如果您想在您的node server 中使用请求库，我们提供了一个NPM包 `@http-svc/server-fetch` diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index e0aefa4..d95c179 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -13,7 +13,7 @@ yarn add http-svc -在初始化HttpService时，可以传入[全局配置](./reference/interface-service.html#初始化) +在初始化HttpService时，可以传入[全局配置](../reference/interface-service.md#初始化) ```ts import { HttpService } from 'http-svc' diff --git a/docs/intro/middleware.md b/docs/intro/middleware.md index 14f4666..daaa65b 100644 --- a/docs/intro/middleware.md +++ b/docs/intro/middleware.md @@ -4,8 +4,6 @@ ## 什么是中间件？ -类型参考详见：[中间件](../guide/reference/interface-middleware-builtin.md) - 中间件可以是一个在请求过程中的`异步的handler` 例如下方是一个最简单的`函数式中间件` @@ -84,3 +82,5 @@ const addSomeParam = async (ctx, next) => { await next() } ``` + +附内置中间件参考：[内置中间件](../reference/interface-middleware-builtin.md) diff --git a/docs/reference/interface-middleware-common.md b/docs/reference/interface-middleware-common.md index c8d49f3..4d68250 100644 --- a/docs/reference/interface-middleware-common.md +++ b/docs/reference/interface-middleware-common.md @@ -2,6 +2,6 @@ 这些中间件大多源自业务中那些高度复用的逻辑而形成，如接口上报、服务端渲染、接口验签、风控等，您可以根据具体的业务、技术场景自由选择。 -当然，您也可以根据自己的业务需求，开发自定义的中间件，具体开发方式和 [替换请求库内置的fetch请求](/guide/custom-fetch.md) 类似。 +当然，您也可以根据自己的业务需求，开发自定义的中间件，具体开发方式和经典案例中的[自定义fetch中间件](../guide/examples.md#自定义fetch) 类似。 公共中间件和内置中间件无任何关联。 diff --git a/docs/reference/interface-service.md b/docs/reference/interface-service.md index a435803..f767a9d 100644 --- a/docs/reference/interface-service.md +++ b/docs/reference/interface-service.md @@ -176,7 +176,7 @@ httpSvc 您在设计中间件时，选择集成HttpSvcMiddleware并且在构造器内调用了super方法传入当前中间件的handler，才能开启默认的disable能力，否则需要您自行在handler内实现 -- **继承自默认中间件，详见[什么是中间件](../middleware.html#什么是中间件)** +- **继承自默认中间件，详见[什么是中间件](../intro/middleware.md#什么是中间件)** ```ts export class HttpSvcAddSomeParams extends HttpSvcMiddleware {