Skip to content

Commit

Permalink
docs: update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
vicanso committed Apr 21, 2020
1 parent 1a5da37 commit 6cb84e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 各类常用的中间件

- [basic auth](#basic-auth) HTTP Basic Auth,建议只用于内部管理系统使用
- [body parser](#body-parser) 请求数据的解析中间件,支持`application/json`以及`application/x-www-form-urlencoded`两种数据类型
- [compress](https://github.com/vicanso/elton-compress) 数据压缩中间件,默认支持gzip、brotli、snappy、s2、zstd以及lz4,也可根据需要增加相应的压缩处理
- [compress](#compress) 数据压缩中间件,默认仅支持gzip。如果需要支持更多的压缩方式,如brotli、snappy、s2、zstd以及lz4,可以使用[elton-compress](https://github.com/vicanso/elton-compress),也可根据需要增加相应的压缩处理
- [concurrent limiter](#concurrent-limiter) 根据指定参数限制并发请求,可用于订单提交等防止重复提交或限制提交频率的场景
- [error handler](#error-handler) 用于将处理函数的Error转换为对应的响应数据,如HTTP响应中的状态码(40x, 50x),对应的出错类别等,建议在实际使用中根据项目自定义的Error对象生成相应的响应数据
- [etag](#etag) 用于生成HTTP响应数据的ETag
Expand All @@ -20,7 +20,7 @@ description: 各类常用的中间件
- [router-concurrent-limiter](#router-concurrent-limiter) 路由并发限制中间件,可以针对路由限制并发请求量。
- [session](https://github.com/vicanso/elton-session) Session中间件,默认支持保存至redis或内存中,也可自定义相应的存储
- [stats](#stats) 请求处理的统计中间件,包括处理时长、状态码、响应数据长度、连接数等信息
- [static serve](static-serve) 静态文件处理中间件,默认支持从目录中读取静态文件或实现StaticFile的相关接口,从[packr](github.com/gobuffalo/packr/v2)或者数据库(mongodb)等读取文件
- [static serve](#static-serve) 静态文件处理中间件,默认支持从目录中读取静态文件或实现StaticFile的相关接口,从[packr](github.com/gobuffalo/packr/v2)或者数据库(mongodb)等读取文件
- [tracker](#tracker) 可以用于在POST、PUT等提交类的接口中增加跟踪日志,此中间件将输出QueryString,Params以及RequestBody部分,并能将指定的字段做"***"的处理,避免输出敏感信息

## basic auth
Expand Down

0 comments on commit 6cb84e4

Please sign in to comment.