admin/MaxKey
1
0
Fork 0
mirror of https://gitee.com/dromara/MaxKey.git synced 2025-12-06 17:08:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

api doc

Browse Source
This commit is contained in:
MaxKey 2021-03-27 09:13:14 +08:00
parent 63411e2dc5
commit 7d5ad8ba7f
21 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/AuthorizeEndpoint.java
View File

@ -41,7 +41,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "认证总地址文档模块")
@Api(tags = "1-2认证总地址文档模块")
@Controller
public class AuthorizeEndpoint extends AuthorizeBaseEndpoint{
@Autowired

2
maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/OnlineTicketEndpoint.java
View File

@ -29,7 +29,7 @@ import org.springframework.web.bind.annotation.ResponseBody;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "在线ticket文档模块")
@Api(tags = "3-1-在线ticket文档模块")
@Controller
@RequestMapping(value={"/onlineticket"})
public class OnlineTicketEndpoint {

2
maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas10AuthorizeEndpoint.java
View File

@ -41,7 +41,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
* https://apereo.github.io/cas/6.2.x/protocol/CAS-Protocol-Specification.html
*/
@Api(tags = "CAS API文档模块")
@Api(tags = "2-3-CAS API文档模块")
@Controller
public class Cas10AuthorizeEndpoint extends CasBaseAuthorizeEndpoint{

2
maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas20AuthorizeEndpoint.java
View File

@ -49,7 +49,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
* https://apereo.github.io/cas/6.2.x/protocol/CAS-Protocol-V2-Specification.html
*/
@Api(tags = "CAS API文档模块")
@Api(tags = "2-3-CAS API文档模块")
@Controller
public class Cas20AuthorizeEndpoint extends CasBaseAuthorizeEndpoint{

2
maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas30AuthorizeEndpoint.java
View File

@ -48,7 +48,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
* https://apereo.github.io/cas/6.2.x/protocol/CAS-Protocol-Specification.html
*/
@Api(tags = "CAS API文档模块")
@Api(tags = "2-3-CAS API文档模块")
@Controller
public class Cas30AuthorizeEndpoint extends CasBaseAuthorizeEndpoint{

2
maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasAuthorizeEndpoint.java
View File

@ -49,7 +49,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
* https://apereo.github.io/cas/6.2.x/protocol/CAS-Protocol.html
*/
@Api(tags = "CAS API文档模块")
@Api(tags = "2-3-CAS API文档模块")
@Controller
public class CasAuthorizeEndpoint extends CasBaseAuthorizeEndpoint{

2
maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasRestV1Endpoint.java
View File

@ -56,7 +56,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
* https://apereo.github.io/cas/6.2.x/protocol/REST-Protocol.html
*/
@Api(tags = "CAS REST API文档模块")
@Api(tags = "2-4-CAS REST API文档模块")
@Controller
public class CasRestV1Endpoint extends CasBaseAuthorizeEndpoint{
final static Logger _logger = LoggerFactory.getLogger(CasRestV1Endpoint.class);

2
maxkey-protocols/maxkey-protocol-extendapi/src/main/java/org/maxkey/authz/exapi/endpoint/ExtendApiAuthorizeEndpoint.java
View File

@ -43,7 +43,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "ExtendApi接口文档模块")
@Api(tags = "2-8-ExtendApi接口文档模块")
@Controller
public class ExtendApiAuthorizeEndpoint extends AuthorizeBaseEndpoint{
final static Logger _logger = LoggerFactory.getLogger(ExtendApiAuthorizeEndpoint.class);

2
maxkey-protocols/maxkey-protocol-formbased/src/main/java/org/maxkey/authz/formbased/endpoint/FormBasedAuthorizeEndpoint.java
View File

@ -47,7 +47,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "FormBased接口文档模块")
@Api(tags = "2-7-FormBased接口文档模块")
@Controller
public class FormBasedAuthorizeEndpoint extends AuthorizeBaseEndpoint{
final static Logger _logger = LoggerFactory.getLogger(FormBasedAuthorizeEndpoint.class);

2
maxkey-protocols/maxkey-protocol-jwt/src/main/java/org/maxkey/authz/token/endpoint/JwtAuthorizeEndpoint.java
View File

@ -50,7 +50,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "JWT令牌接口")
@Api(tags = "2-5-JWT令牌接口")
@Controller
public class JwtAuthorizeEndpoint extends AuthorizeBaseEndpoint{

2
maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/AuthorizationEndpoint.java
View File

@ -93,7 +93,7 @@ import org.maxkey.authz.oauth2.provider.ClientDetailsService;
* @author Vladimir Kryachko
*
*/
@Api(tags = "OAuth v2.0 API文档模块")
@Api(tags = "2-1-OAuth v2.0 API文档模块")
@Controller
@SessionAttributes("authorizationRequest")
public class AuthorizationEndpoint extends AbstractEndpoint {

2
maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/CheckTokenEndpoint.java
View File

@ -56,7 +56,7 @@ import io.swagger.annotations.ApiOperation;
* @author Luke Taylor
* @author Joel D'sa
*/
@Api(tags = "OAuth v2.0 API文档模块")
@Api(tags = "2-1-OAuth v2.0 API文档模块")
@Controller
public class CheckTokenEndpoint {

2
maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/TokenEndpoint.java
View File

@ -72,7 +72,7 @@ import io.swagger.annotations.ApiOperation;
* @author Dave Syer
*
*/
@Api(tags = "OAuth v2.0 API文档模块")
@Api(tags = "2-1-OAuth v2.0 API文档模块")
@Controller
public class TokenEndpoint extends AbstractEndpoint {

2
maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/userinfo/endpoint/UserInfoEndpoint.java
View File

@ -76,7 +76,7 @@ import io.swagger.annotations.ApiOperation;
import com.nimbusds.jwt.SignedJWT;
@Api(tags = "OAuth v2.0 API文档模块")
@Api(tags = "2-1-OAuth v2.0 API文档模块")
@Controller
@RequestMapping(value = { "/api" })
public class UserInfoEndpoint {

2
maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/metadata/endpoint/MetadataEndpoint.java
View File

@ -52,7 +52,7 @@ import org.springframework.web.bind.annotation.ResponseBody;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "SAML v2.0 API文档模块")
@Api(tags = "2-2-SAML v2.0 API文档模块")
@Controller
@RequestMapping(value = { "/metadata/saml20/" })
public class MetadataEndpoint {

2
maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/IdpInitEndpoint.java
View File

@ -49,7 +49,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "SAML v2.0 API文档模块")
@Api(tags = "2-2-SAML v2.0 API文档模块")
@Controller
public class IdpInitEndpoint {
private final static Logger logger = LoggerFactory.getLogger(IdpInitEndpoint.class);

2
maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/LogoutSamlEndpoint.java
View File

@ -40,7 +40,7 @@ import org.springframework.web.servlet.ModelAndView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "SAML v2.0 API文档模块")
@Api(tags = "2-2-SAML v2.0 API文档模块")
@Controller
public class LogoutSamlEndpoint {
private final static Logger logger = LoggerFactory.getLogger(LogoutSamlEndpoint.class);

2
maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/SingleSignOnEndpoint.java
View File

@ -48,7 +48,7 @@ import org.springframework.web.servlet.ModelAndView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "SAML v2.0 API文档模块")
@Api(tags = "2-2-SAML v2.0 API文档模块")
@Controller
public class SingleSignOnEndpoint {
private final static Logger logger = LoggerFactory.getLogger(SingleSignOnEndpoint.class);

2
maxkey-protocols/maxkey-protocol-tokenbased/src/main/java/org/maxkey/authz/token/endpoint/TokenBasedAuthorizeEndpoint.java
View File

@ -50,7 +50,7 @@ import io.swagger.annotations.ApiOperation;
* @author Crystal.Sea
*
*/
@Api(tags = "TokenBased接口文档模块")
@Api(tags = "2-6-TokenBased接口文档模块")
@Controller
public class TokenBasedAuthorizeEndpoint extends AuthorizeBaseEndpoint{

5
maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LoginEndpoint.java
View File

@ -43,10 +43,14 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
/**
* @author Crystal.Sea
*
*/
@Api(tags = "1-1-登录接口文档模块")
@Controller
public class LoginEndpoint {
private static Logger _logger = LoggerFactory.getLogger(LoginEndpoint.class);
@ -79,6 +83,7 @@ public class LoginEndpoint {
* init login
* @return
*/
@ApiOperation(value = "登录接口", notes = "用户登录地址",httpMethod="GET")
@RequestMapping(value={"/login"})
public ModelAndView login() {
_logger.debug("LoginController /login.");

2
maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LogoutEndpoint.java
View File

@ -51,7 +51,7 @@ import org.springframework.web.servlet.ModelAndView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(tags = "单点注销接口文档模块")
@Api(tags = "1-3-单点注销接口文档模块")
@Controller
public class LogoutEndpoint {