jap/README.md
yadong.zhang a22b847478 docs:
2021-10-08 17:08:41 +08:00

113 lines
6.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<img src="https://images.gitee.com/uploads/images/2021/0218/094114_99925b8b_784199.png" width="200">
</p>
<p align="center">
<strong>Just auth into any app</strong>
</p>
<p align="center">
<a target="_blank" href="https://search.maven.org/search?q=jap">
<img src="https://img.shields.io/github/v/release/fujieid/jap?style=flat-square" ></img>
</a>
<a target="_blank" href="https://oss.sonatype.org/content/repositories/snapshots/com/fujieid/">
<img src="https://img.shields.io/nexus/s/https/oss.sonatype.org/com.fujieid/jap-bom.svg?style=flat-square" ></img>
</a>
<a target="_blank" href="https://gitee.com/yadong.zhang/JustAuth/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-LGPL%203.0-yellow" ></img>
</a>
<a href="https://www.codacy.com/gh/fujieid/jap/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=fujieid/jap&amp;utm_campaign=Badge_Grade">
<img src="https://app.codacy.com/project/badge/Grade/c4c76cde65594819ab3de3e25e9b99d4"/>
</a>
<a target="_blank" href="https://codecov.io/gh/fujieid/jap" title="codecov">
<img src="https://codecov.io/gh/fujieid/jap/branch/master/graph/badge.svg?token=WmfmgwxtnJ" ></img>
</a>
<a target="_blank" href="https://travis-ci.com/fujieid/jap" title="ci">
<img src="https://travis-ci.com/fujieid/jap.svg?branch=master&status=passed" ></img>
</a>
<a target="_blank" href="https://gitter.im/fujieid/JAP?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
<img src="https://badges.gitter.im/fujieid/JAP.svg" ></img>
</a>
</p>
<p align="center">
<a target="_blank" href='https://gitee.com/fujieid/jap/stargazers'>
<img src="https://gitee.com/fujieid/jap/badge/star.svg?theme=gvp" alt='star'></img>
</a>
<a target="_blank" href='https://github.com/fujieid/jap/stargazers'>
<img src="https://img.shields.io/github/stars/fujieid/jap?style=social" alt='star'></img>
</a>
</p>
<p align="center">
<strong>开源地址:</strong> <a target="_blank" href='https://gitee.com/fujieid/jap'>Gitee</a> | <a target="_blank" href='https://github.com/fujieid/jap'>Github</a> | <a target="_blank" href='https://codechina.csdn.net/fujieid/jap'>CodeChina</a>
</p>
<p align="center">
<strong>社区论坛:</strong> <a target="_blank" href='https://discuss.justauth.plus'>https://discuss.justauth.plus</a>
</p>
<p align="center">
<strong>API 文档:</strong> <a target="_blank" href='https://apidoc.gitee.com/fujieid/jap'>https://apidoc.gitee.com/fujieid/jap</a>
</p>
<p align="center">
<strong>开发者文档:</strong> <a target="_blank" href='https://justauth.plus'>https://justauth.plus</a>
</p>
## 🎨 JAP 是什么?
JustAuthPlus以下简称"**JAP**")是一款开源的登录认证中间件,基于模块化设计,为所有需要登录认证的 WEB 应用提供一套标准的技术解决方案,开发者可以基于 JAP 适配绝大多数的 WEB 系统(自有系统、联邦协议),就像集成 [JustAuth](https://gitee.com/yadong.zhang/JustAuth) 一样,简单方便。
## ✨ JAP 有什么特性?
- **易用性**JAP 的 API 沿袭 JustAuth 的简单性做到了开箱即用的程度。JAP 高度抽象各种登录场景,提供了多套简单使用的 API极大程度的降低了开发者的学习成本和使用成本
- **全面性**JAP 全量适配 JustAuth 支持的第三方平台实现第三方登录。同时也支持所有基于标准OAuth2.0 协议或者 OIDC 协议或者 SAML 协议的应用、系统,同时 JAP 还提供不同语言版本的项目 SDK适配多种研发场景
- **模块化**JAP 基于模块化设计开发针对每一种登录场景比如账号密码、OAuth、OIDC等都单独提供了独有的模块化解决方案
- **标准化**JAP 和业务完全解耦,将登录认证相关的逻辑抽象出一套标准的技术解决方案,针对每一种业务场景,比如用户登录、验证密码、创建并绑定第三方系统的账号等,都提供了一套标准的策略或者接口,开发者可以基于 JAP灵活并方便的完成相关业务逻辑的开发和适配
- **通用性**JAP 不仅可以用到第三方登录、OAuth授权、OIDC认证等业务场景还能适配开发者现有的业务系统的普通账号密码的登录场景基本将所有登录相关的业务场景都已经涵盖。针对 WEB 应用JAP 将提供满足各种不同登录场景的解决方案(和开发语言无关)
## 🎯 JAP 有什么功能?
![](docs/media/01c3231f.png)
## 💥 适用于哪些场景?
JAP 适用于所有需要登录功能的场景。比如:
- **标准规范**:新项目立项,你们需要研发一套包含登录、认证的系统,并且需要一套标准的、灵活的、功能全面的登录认证功能。
- **需求灵活**:现有登录模块为自研,但是新一轮的技术规划中,你们想将登录认证模块重构,以更加灵活的架构适应后面的新需求,比如:集成 MFA 登录、集成 OAuth 登录、SAML登录等。
- **力求省事**你们的项目太多或者是开发语言较多比如Java、Python、Node 等),每个项目都需要登录认证模块,想解决这种重复劳动的问题,使研发人员有更多的时间和精力投入到业务开发中,提高研发产能和研发效率。
- ...
## 🚀 开源推荐
- `JustAuth` 开箱即用的整合第三方登录的开源组件: [https://github.com/justauth/JustAuth](https://github.com/justauth/JustAuth)
- `spring-boot-demo` 深度学习并实战 spring boot 的项目: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo)
- `mica` SpringBoot 微服务高效开发工具集: [https://github.com/lets-mica/mica](https://github.com/lets-mica/mica)
- `pig` 宇宙最强微服务认证授权脚手架(架构师必备): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)
- `SpringBlade` 完整的线上解决方案(企业开发必备): https://gitee.com/smallc/SpringBlade
## 🚀 他们在用
![](docs/media/jai-h50.png) ![](docs/media/liuniu-h50.png) ![](docs/media/mica-h50.png)
## 👪 贡献者列表
[![contributors](https://whnb.wang/contributors/fujieid/jap)](https://whnb.wang)
## 🏘️ 加入社群
<img width="120" src="docs/media/wechat.png">
## 💹 统计图
### Gitee
<p align="center">
<a target="_blank" href='https://gitee.com/fujieid/jap'><img src="https://whnb.wang/img/fujieid/jap"></a>
</p>
### Github
<p align="center">
<a target="_blank" href='https://gitee.com/fujieid/jap'><img src="https://starchart.cc/fujieid/jap.svg"></a>
</p>
### Product Hunt
<a href="https://www.producthunt.com/posts/justauthplus?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-justauthplus" target="_blank">
<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=285597&theme=dark" alt="JustAuthPlus - Just auth into any app | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" />
</a>