README.en-US.md

Login, so easy.

查看更多

---

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 | github
Docs：Reference Doc

Features

1. Multiple platform: Has integrated more than a dozen third-party platforms.(plan)
2. Minimalist: The minimalist design is very simple to use.

Quick start

• Add maven dependency

These artifacts are available from Maven Central:

<dependency>
    <groupId>me.zhyd.oauth</groupId>
    <artifactId>JustAuth</artifactId>
    <version>1.15.4-alpha</version>
</dependency>

• Using JustAuth

// Create authorization request
AuthRequest authRequest = new AuthGiteeRequest(AuthConfig.builder()
        .clientId("clientId")
        .clientSecret("clientSecret")
        .redirectUri("redirectUri")
        .build());
// Generate authorization url
authRequest.authorize("state");
// After authorization to login, it will return: code(auth_code(Alipay only)),state, After version 1.8.0, you can use the AuthCallback as a parameter to the callback interface
// Note: JustAuth saves state for 3 minutes by default. If it is not used within 3 minutes, the expired state will be cleared automatically.
authRequest.login(callback);

Note, that since v1.14.0 JustAuth has been integrated by default with simple-http as the HTTP general interface (see the update JustAuth 1.14.0 release! Perfect decoupling of HTTP tools). Since most projects already integrate HTTP tools such as OkHttp3, apache HttpClient, and hutool-http), in order to reduce unnecessary dependencies,Starting from v1.14.0, JustAuth will not integrate hutool-http by default. If the developer's project is new or there is no integrated HTTP implementation tool in the project, please add the corresponding HTTP implementation class by yourself. Alternative dependencies are as follows:

• hutool-http

  <dependency>
      <groupId>cn.hutool</groupId>
      <artifactId>hutool-http</artifactId>
      <version>5.2.5</version>
  </dependency>

• httpclient

  <dependency>
  	<groupId>org.apache.httpcomponents</groupId>
    	<artifactId>httpclient</artifactId>
    	<version>4.5.12</version>
  </dependency>

• okhttp

  <dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.4.1</version>
  </dependency>

Examples：

• Springboot Example
• jFinal Example: by xkcoding
• ActFramework Example: by xkcoding
• Nutzboot Example: by 蛋蛋
• Blade Example

Springboot Starter

• justauth-spring-boot-starter: Spring Boot integrates best practices with JustAuth by xkcoding
• justauth-spring-boot-starter-demo: Justauth-spring-boot-starter demo project by xkcoding

API

💻 platform	☕ API	📄 Official document
	AuthGiteeRequest	参考文档
	AuthGithubRequest	参考文档
	AuthWeiboRequest	参考文档
	AuthDingTalkRequest	参考文档
	AuthBaiduRequest	参考文档
	AuthCodingRequest	参考文档
	AuthTencentCloudRequest	参考文档
	AuthOschinaRequest	参考文档
	AuthAlipayRequest	参考文档
	AuthQqRequest	参考文档
	AuthWeChatOpenRequest	参考文档
	AuthWeChatMpRequest	参考文档
	AuthWeChatEnterpriseRequest	参考文档
	AuthTaobaoRequest	参考文档
	AuthGoogleRequest	参考文档
	AuthFacebookRequest	参考文档
	AuthDouyinRequest	参考文档
	AuthLinkedinRequest	参考文档
	AuthMicrosoftRequest	参考文档
	AuthMiRequest	参考文档
	AuthToutiaoRequest	参考文档
	AuthTeambitionRequest	参考文档
	AuthRenrenRequest	参考文档
	AuthPinterestRequest	参考文档
	AuthStackOverflowRequest	参考文档
	AuthHuaweiRequest	参考文档
	AuthKujialeRequest	参考文档
	AuthGitlabRequest	参考文档
	AuthMeituanRequest	参考文档
	AuthElemeRequest	参考文档
	AuthTwitterRequest	参考文档
	AuthCsdnRequest	无

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.

Contributors

contributors

Recommend

• spring-boot-demo In-depth study and actual combat of spring boot projects: https://github.com/xkcoding/spring-boot-demo
• mica Efficient Development of scaffolding by Spring Cloud: https://github.com/lets-mica/mica
• pig Cosmic strongest Micro Services Certified authorized scaffolding (essential for Architects): https://gitee.com/log4j/pig
• SpringBlade Complete online solution (necessary for enterprise development): https://gitee.com/smallc/SpringBlade

References

• The OAuth 2.0 Authorization Framework
• OAuth 2.0