提交 18051e48 编写于 作者: sinat_25235033's avatar sinat_25235033

update and synchronize english docs

上级 a3dc8cb5
......@@ -38,5 +38,5 @@ api的保护可以认为:认证-请求携带的认证信息是否校验通过
- [x] quarkus [sample-quarkus](sample-quarkus.md)
- [x] javalin [sample-javalin](sample-javalin.md)
- [x] ktor [sample-ktor](sample-ktor.md)
- [x] spring webflux [spring-webflux-sureness](samples/spring-webflux-sureness)
- [x] spring webflux [spring-webflux-sureness](sample-spring-webflux.md)
- [x] more samples todo
......@@ -16,17 +16,17 @@
> Support dynamic modification of permissions
> Support mainstream http container(servlet and jax-rs)
> Supports JWT, Basic Auth... Can extend custom supported authentication methods
> [High performance due dictionary matching tree](#Why Is High Performance)
> High performance due dictionary matching tree
> Good extension interface, demo and document.
> The low configuration of sureness, easy to expand, and not coupled with other frameworks, enables developers to quickly and safely protect their projects in multiple scenarios.
##### Framework Sample Support
- [x] spring [sample-bootstrap](sample-bootstrap)
- [x] springboot [sample-tom](sample-tom)
- [x] quarkus [sample-quarkus](samples/quarkus-sureness)
- [x] javalin [sample-javalin](samples/javalin-sureness)
- [x] ktor [sample-ktor](samples/ktor-sureness)
- [x] spring webflux [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] more samples todo
- [x] spring [sample-bootstrap](en/sample-bootstrap.md)
- [x] springboot [sample-tom](en/sample-tom.md)
- [x] quarkus [sample-quarkus](en/sample-quarkus.md)
- [x] javalin [sample-javalin](en/sample-javalin.md)
- [x] ktor [sample-ktor](en/sample-ktor.md)
- [x] spring webflux [spring-webflux-sureness](en/sample-spring-webflux.md)
- [x] more samples todo
......@@ -14,7 +14,7 @@ Authorization: Bearer eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNocjEEOwiAQRe8y65IwC
```
we can use it in postman: add jwt in Bearer Token.
![jwtPostmanUse](_images/jwtPostmanUse.png)
![jwtPostmanUse](../_images/jwtPostmanUse.png)
#### `basic auth`
`basic auth` - `Basic access authentication`, is a classic `http` basic authentication method.
......@@ -28,11 +28,11 @@ Authorization: Basic dG9tOjMyMTEz
```
we can use it in postman: add username password in `Basic Auth` type's `Authorization`, postman would encrypt it automatically.
![basicAuthPostmanUse](_images/basicAuthPostmanUse.png)
![basicAuthPostmanUse](../_images/basicAuthPostmanUse.png)
#### other auth type
Sureness currently supports these two types for the time being, and will continue to expand other basic authentication methods in the future.
Of course, you can easily customize the authentication method,detail[Custom Subject](en/custom-subject.md)
Of course, you can easily customize the authentication method, detail [Custom Subject](en/custom-subject.md)
We provide the demo to use default authentication method, detail please refer to [10 Minute Tutorial's Program--sample-bootstrap](en/sample-bootstrap.md)
Also we provide the demo to custom authentication method, detail please refer to [30 Minute Tutorial's Program--sample-tom](en/sample-tom.md)
......
## Default Sureness Exception
`sureness` uses the exception handling process, we need to customize the corresponding exceptions thrown by the authentication failure or unauthorized access in the authentication process of `checkIn`.
`sureness`使用异常处理流程,我们需要对`checkIn`的认证鉴权流程中发生的认证失败或无权限访问等抛出的相应异常做自定义处理,
If the authentication is successful, it will pass directly, if it fails, a specific exception will be thrown, and the exception will be caught, eg:
```
try {
......
......@@ -68,7 +68,7 @@ Also, we provide default dataSource implement which load dataSource from txt(sur
Default Document DataSource Config - sureness.yml, see: [Default DataSource](en/default-datasource.md)
If the configuration resource data comes from text, please refer to [10 Minute Tutorial's Program--sample-bootstrap](https://github.com/tomsun28/sureness/tree/master/sample-bootstrap)
If the configuration resource data comes from dataBase, please refer to [30 Minute Tutorial's Program--sample-tom](https://github.com/tomsun28/sureness/tree/master/sample-tom)
If the configuration resource data comes from text, please refer to [10 Minute Tutorial's Program--sample-bootstrap](en/sample-bootstrap.md)
If the configuration resource data comes from dataBase, please refer to [30 Minute Tutorial's Program--sample-tom](en/sample-tom.md)
**Have Fun**
\ No newline at end of file
......@@ -2,7 +2,7 @@
[spring-webflux-sureness sample repository](https://github.com/tomsun28/sureness/tree/master/samples/spring-webflux-sureness)
- 基于`spring-webflux`
- Based on `spring-webflux`
- Custom subject creator (BasicSubjectReactiveCreator, JwtSubjectReactiveCreator, NoneSubjectReactiveCreator) adapt to ServerHttpRequest request body
- Load data from default dataSource - `sureness.yml`
- Use default `jwt,basic auth` to authenticate and authorize
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册