iSharkFly-Open/JustAuth
1
0
Fork 0
mirror of synced 2026-05-22 13:43:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c0ac81df08b72a6666d980df3755419cb723d80d
JustAuth/README.en-US.md
T

200 lines
6.5 KiB
Markdown
Raw Normal View History

📝 编写文档
2019-08-23 20:05:26 +08:00
<p align="center">
替换 justauth.wiki 域名，该域名暂时不可用，请使用 justauth.cn
2023-04-11 22:34:18 +08:00
<a href="https://www.justauth.cn"><img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/Justauth.png" width="400"></a>
📝 编写文档
2019-08-23 20:05:26 +08:00
</p>
<p align="center">
<strong>Login, so easy.</strong>
</p>
<p align="center">
<a target="_blank" href="https://search.maven.org/search?q=JustAuth">
✨ 增加“程序员客栈”
2021-06-03 15:18:51 +08:00
<img src="https://img.shields.io/github/v/release/justauth/JustAuth?style=flat-square" ></img>
📝 编写文档
2019-08-23 20:05:26 +08:00
</a>
📝 Writing docs.
2021-08-13 18:26:23 +08:00
<a target="_blank" href="https://oss.sonatype.org/content/repositories/snapshots/me/zhyd/oauth/JustAuth/">
<img src="https://img.shields.io/nexus/s/https/oss.sonatype.org/me.zhyd.oauth/JustAuth.svg?style=flat-square" ></img>
</a>
📝 编写文档
2019-08-23 20:05:26 +08:00
<a target="_blank" href="https://gitee.com/yadong.zhang/JustAuth/blob/master/LICENSE">
<img src="https://img.shields.io/apm/l/vim-mode.svg?color=yellow" ></img>
</a>
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
<img src="https://img.shields.io/badge/JDK-1.8+-green.svg" ></img>
</a>
替换 justauth.wiki 域名，该域名暂时不可用，请使用 justauth.cn
2023-04-11 22:34:18 +08:00
<a target="_blank" href="https://www.justauth.cn" title="参考文档">
📝 编写文档
2019-08-23 20:05:26 +08:00
<img src="https://img.shields.io/badge/Docs-latest-blueviolet.svg" ></img>
</a>
💡 修改文档
2021-02-19 17:51:14 +08:00
<a href="https://codecov.io/gh/justauth/JustAuth">
<img src="https://codecov.io/gh/justauth/JustAuth/branch/master/graph/badge.svg?token=zYiAqd9aFz" />
📝 编写文档
2019-08-23 20:05:26 +08:00
</a>
<a href='https://gitee.com/yadong.zhang/JustAuth/stargazers'>
💡 修改文档
2021-02-19 17:52:29 +08:00
<img src='https://gitee.com/yadong.zhang/JustAuth/badge/star.svg?theme=gvp' alt='star'></img>
📝 编写文档
2019-08-23 20:05:26 +08:00
</a>
<a target="_blank" href='https://github.com/zhangyd-c/JustAuth'>
<img src="https://img.shields.io/github/stars/zhangyd-c/JustAuth.svg?style=social" alt="github star"></img>
</a>
</p>
📝 文档
2021-03-29 11:00:56 +08:00
-------------------------------------------------------------------------------
<p align="center">
<img src='./docs/media/75a3c076.png' alt='star'></img>
</p>
📝 编写文档
2019-08-23 20:05:26 +08:00
-------------------------------------------------------------------------------
`JustAuth`, as you see, It is just a Java library of third-party authorized login, It's smaller and easier to use. JustAuth is the best third-party login tool written in JAVA.
Source Code：[gitee](https://gitee.com/yadong.zhang/JustAuth) | [github](https://github.com/zhangyd-c/JustAuth)
替换 justauth.wiki 域名，该域名暂时不可用，请使用 justauth.cn
2023-04-11 22:34:18 +08:00
Docs：[Reference Doc](https://www.justauth.cn)
📝 编写文档
2019-08-23 20:05:26 +08:00
## Features
🍻 文档、删除AuthRequestTest
2019-09-20 19:33:52 +08:00
1. **Multiple platform**: Has integrated more than a dozen third-party platforms.([plan](https://gitee.com/yadong.zhang/JustAuth/issues/IUGRK))
📝 编写文档
2019-08-23 20:05:26 +08:00
2. **Minimalist**: The minimalist design is very simple to use.
## Quick start
📝 Writing docs.
2021-08-13 18:26:23 +08:00
### Add maven dependency
- Add JustAuth dependency
📝 编写文档
2019-08-23 20:05:26 +08:00
These artifacts are available from Maven Central:
```xml
<dependency>
<groupId>me.zhyd.oauth</groupId>
<artifactId>JustAuth</artifactId>
📝 Writing docs.
2021-08-13 18:26:23 +08:00
<version>{latest-version}</version>
📝 编写文档
2019-08-23 20:05:26 +08:00
</dependency>
```
📝 Writing docs.
2021-08-13 18:26:23 +08:00
> **latest-version** ：
> - CURRENT: ![](https://img.shields.io/github/v/release/justauth/JustAuth?style=flat-square)
> - SNAPSHOT: ![](https://img.shields.io/nexus/s/https/oss.sonatype.org/me.zhyd.oauth/JustAuth.svg?style=flat-square)
📝 编写文档
2020-04-08 00:59:51 +08:00
📝 Writing docs.
2021-08-13 18:26:23 +08:00
- Add http dependency（Only need one）
> If there is already in the project, please ignore it. In addition, you need to pay special attention. If the low version of the dependency has been introduced in the project, please exclude the low version of the dependency first, and then introduce the high version or the latest version of the dependency
📝 编写文档
2020-04-08 00:59:51 +08:00
- hutool-http
```xml
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-http</artifactId>
<version>5.2.5</version>
</dependency>
```
- httpclient
```xml
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.12</version>
</dependency>
```
- okhttp
```xml
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>4.4.1</version>
</dependency>
```
📝 Writing docs.
2021-08-13 18:26:23 +08:00
### Using JustAuth API
#### Simple
```java
// Create authorization request
AuthRequest authRequest = new AuthGiteeRequest(AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build());
// Generate authorization page url
authRequest.authorize("state");
// Get token and userinfo
authRequest.login(callback);
```
#### Builder 1. Use unchanging `AuthConfig`
```java
// Create authorization request
AuthRequest authRequest = AuthRequestBuilder.builder()
.source("github")
.authConfig(AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build())
.build();
```
#### Builder 2. Use dynamic `AuthConfig`
```java
// Create authorization request
AuthRequest authRequest = AuthRequestBuilder.builder()
.source("gitee")
.authConfig((source) -> {
// Use source to dynamically get AuthConfig
// Here you can flexibly take the configuration from sql or take the configuration from the configuration file
return AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build();
})
.build();
```
#### Builder 3. Support custom platform
```java
AuthRequest authRequest = AuthRequestBuilder.builder()
// Key point: configure the custom implementation of AuthSource
.extendSource(AuthExtendSource.values())
// Enum name in AuthExtendSource
.source("other")
// ... Do other things
.build();
```
📝 编写文档
2019-08-23 20:05:26 +08:00
## Contributions
1. Fork this project to your repository
2. Clone the project after fork.
3. Modify the code (either to fix issue, or to add new features)
4. Commit and push code to a remote repository
5. Create a new PR (pull request), and select `dev` branch
6. Waiting for author to merge
I look forward to your joining us.
🍻 文档
2019-09-17 18:38:35 +08:00
## Contributors
替换 justauth.wiki 域名，该域名暂时不可用，请使用 justauth.cn
2023-04-11 22:34:18 +08:00
[contributors](https://www.justauth.cn/contributors.html)
🍻 文档
2019-09-17 18:38:35 +08:00
🍻 AuthUser 中新增 rawUserInfo，用来存放第三方平台返回的原始用户数据
2020-06-07 18:46:00 +08:00
## Change Logs
替换 justauth.wiki 域名，该域名暂时不可用，请使用 justauth.cn
2023-04-11 22:34:18 +08:00
[CHANGELOGS](https://www.justauth.cn/update.html)
🍻 AuthUser 中新增 rawUserInfo，用来存放第三方平台返回的原始用户数据
2020-06-07 18:46:00 +08:00
🍻 文档
2019-09-17 18:38:35 +08:00
## Recommend
- `spring-boot-demo` In-depth study and actual combat of spring boot projects: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo)
- `mica` Efficient Development of scaffolding by Spring Cloud: [https://github.com/lets-mica/mica](https://github.com/lets-mica/mica)
- `pig` Cosmic strongest Micro Services Certified authorized scaffolding (essential for Architects): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)
- `SpringBlade` Complete online solution (necessary for enterprise development): https://gitee.com/smallc/SpringBlade
📝 编写文档
2019-08-23 20:05:26 +08:00
## References
- [The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749)
update doc
2019-09-30 10:18:27 +08:00
- [OAuth 2.0](https://oauth.net/2/)
Reference in New Issue Copy Permalink