diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..854e6cb0e92c60ceec78735dfbf060acc590b273 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,125 @@ +

+ +

+

+ Login, so easy! +

+

+ 史上最全的整合第三方登录的开源库 +

+

+ + + + + + + + + + + + + + + + + star + + + github star + +

+

+ 开源地址: Gitee | Github +

+

+ QQ群:230017570 +

+

+ 文档更新日期: {docsify-updated} +

+ +## 简介 + +JustAuth,如你所见,它仅仅是一个**第三方授权登录**的**工具类库**,它可以让我们脱离繁琐的第三方登录SDK,让登录变得**So easy!** + +## 特点 + +废话不多说,就俩字: + +1. **全**:已集成十多家第三方平台(国内外常用的基本都已包含),后续依然还有扩展计划! +2. **简**:API就是奔着最简单去设计的,尽量让您用起来没有障碍感! + +## 已集成的平台 + +| :computer: 平台 | :coffee: API类 | :page_facing_up: SDK | +|:------:|:-------:|:-------:| +| | [AuthGiteeRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthGiteeRequest.java) | 参考文档 | +| | [AuthGithubRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthGiteeRequest.java) | 参考文档 | +| | [AuthWeiboRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthGiteeRequest.java) | 参考文档 | +| | [AuthDingTalkRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthDingTalkRequest.java) | 参考文档 | +| | [AuthBaiduRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthBaiduRequest.java) | 参考文档 | +| | [AuthCodingRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthCodingRequest.java) | 参考文档 | +| | [AuthTencentCloudRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthTencentCloudRequest.java) | 参考文档 | +| | [AuthOschinaRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthOschinaRequest.java) | 参考文档 | +| | [AuthAlipayRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthAlipayRequest.java) | 参考文档 | +| | [AuthQqRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthQqRequest.java) | 参考文档 | +| | [AuthWeChatRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthWeChatRequest.java) | 参考文档 | +| | [AuthTaobaoRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthTaobaoRequest.java) | 参考文档 | +| | [AuthGoogleRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthGoogleRequest.java) | 参考文档 | +| | [AuthFacebookRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthFacebookRequest.java) | 参考文档 | +| | [AuthDouyinRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthDouyinRequest.java) | 参考文档 | +| | [AuthLinkedinRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthLinkedinRequest.java) | 参考文档 | +| | [AuthMicrosoftRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthMicrosoftRequest.java) | 参考文档 | +| | [AuthMiRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthMiRequest.java) | 参考文档 | +| | [AuthToutiaoRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthToutiaoRequest.java) | 参考文档 | +| | [AuthTeambitionRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthTeambitionRequest.java) | 参考文档 | +| | [AuthRenrenRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthRenrenRequest.java) | 参考文档 | +| | [AuthPinterestRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthPinterestRequest.java) | 参考文档 | +| | [AuthStackOverflowRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthStackOverflowRequest.java) | 参考文档 | +| | [AuthCsdnRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java) | 无 | + + +## 快速开始 + +- 引入依赖 +```xml + + me.zhyd.oauth + JustAuth + 1.9.5 + +``` +- 调用api +```java +// 创建授权request +AuthRequest authRequest = new AuthGiteeRequest(AuthConfig.builder() + .clientId("clientId") + .clientSecret("clientSecret") + .redirectUri("redirectUri") + .build()); +// 生成授权页面 +authRequest.authorize(); +// 授权登录后会返回code(auth_code(仅限支付宝))、state,1.8.0版本后,可以用AuthCallback类作为回调接口的参数 +// 注:JustAuth默认保存state的时效为3分钟,3分钟内未使用则会自动清除过期的state +authRequest.login(callback); +``` + +## 贡献代码 + +1. fork本项目到自己的repo +2. 把fork过去的项目也就是你仓库中的项目clone到你的本地 +3. 修改代码 +4. commit后push到自己的库 +5. 发起PR(pull request) 请求,提交到`dev`分支 +6. 等待作者合并 + +_注:JustAuth只接受集成oauth2.0的平台_ + +## 捐赠 + +| 支付宝 | 微信 | +| :------------: | :------------: | +| | | + diff --git a/docs/_media/cover.png b/docs/_media/cover.png new file mode 100644 index 0000000000000000000000000000000000000000..89f5847921ba48e6e2189771196d468854dd1929 Binary files /dev/null and b/docs/_media/cover.png differ diff --git a/docs/_media/logo.png b/docs/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..2d326a4504b357f4778941d2183561df58e5f167 Binary files /dev/null and b/docs/_media/logo.png differ diff --git a/docs/_media/logo_i.png b/docs/_media/logo_i.png new file mode 100644 index 0000000000000000000000000000000000000000..2a8c8b79fc40a7840bc57afeb79da555f1bf0af9 Binary files /dev/null and b/docs/_media/logo_i.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..9e1864e8e19a3374a279ff68371a9ae303e1f0fc Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000000000000000000000000000000000000..db2510304ec4e6054931db8f728c477b7706a296 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,55 @@ + + + + + JustAuth - 史上最全的整合第三方登录的开源库 + + + + + + + + + + + + + + + + +
Please wait...
+ + + +