diff --git a/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/AuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/AuthorizeEndpoint.java index 7dc16e774..bc6de5795 100644 --- a/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/AuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/AuthorizeEndpoint.java @@ -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 diff --git a/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/OnlineTicketEndpoint.java b/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/OnlineTicketEndpoint.java index 89de98990..224edff2f 100644 --- a/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/OnlineTicketEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-authorize/src/main/java/org/maxkey/authz/endpoint/OnlineTicketEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas10AuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas10AuthorizeEndpoint.java index d6c3b3811..7568251c6 100644 --- a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas10AuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas10AuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas20AuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas20AuthorizeEndpoint.java index 707ead873..320bfb293 100644 --- a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas20AuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas20AuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas30AuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas30AuthorizeEndpoint.java index 7fd427996..42ba16a56 100644 --- a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas30AuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/Cas30AuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasAuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasAuthorizeEndpoint.java index 3130f639d..72db6eb30 100644 --- a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasAuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasAuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasRestV1Endpoint.java b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasRestV1Endpoint.java index 4abe0a835..65556eb85 100644 --- a/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasRestV1Endpoint.java +++ b/maxkey-protocols/maxkey-protocol-cas/src/main/java/org/maxkey/authz/cas/endpoint/CasRestV1Endpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-extendapi/src/main/java/org/maxkey/authz/exapi/endpoint/ExtendApiAuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-extendapi/src/main/java/org/maxkey/authz/exapi/endpoint/ExtendApiAuthorizeEndpoint.java index 6db054743..5ed4e1a7b 100644 --- a/maxkey-protocols/maxkey-protocol-extendapi/src/main/java/org/maxkey/authz/exapi/endpoint/ExtendApiAuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-extendapi/src/main/java/org/maxkey/authz/exapi/endpoint/ExtendApiAuthorizeEndpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-formbased/src/main/java/org/maxkey/authz/formbased/endpoint/FormBasedAuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-formbased/src/main/java/org/maxkey/authz/formbased/endpoint/FormBasedAuthorizeEndpoint.java index 68fc94a24..21f6d6c7d 100644 --- a/maxkey-protocols/maxkey-protocol-formbased/src/main/java/org/maxkey/authz/formbased/endpoint/FormBasedAuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-formbased/src/main/java/org/maxkey/authz/formbased/endpoint/FormBasedAuthorizeEndpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-jwt/src/main/java/org/maxkey/authz/token/endpoint/JwtAuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-jwt/src/main/java/org/maxkey/authz/token/endpoint/JwtAuthorizeEndpoint.java index 8841af55c..9854b96d4 100644 --- a/maxkey-protocols/maxkey-protocol-jwt/src/main/java/org/maxkey/authz/token/endpoint/JwtAuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-jwt/src/main/java/org/maxkey/authz/token/endpoint/JwtAuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/AuthorizationEndpoint.java b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/AuthorizationEndpoint.java index 6048a2257..3e2d8717d 100644 --- a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/AuthorizationEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/AuthorizationEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/CheckTokenEndpoint.java b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/CheckTokenEndpoint.java index c98ddf75f..9b2144fbe 100644 --- a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/CheckTokenEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/CheckTokenEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/TokenEndpoint.java b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/TokenEndpoint.java index 1f843ed05..80b8e5f2a 100644 --- a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/TokenEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/endpoint/TokenEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/userinfo/endpoint/UserInfoEndpoint.java b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/userinfo/endpoint/UserInfoEndpoint.java index 7c6233c0e..aff288684 100644 --- a/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/userinfo/endpoint/UserInfoEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-oauth-2.0/src/main/java/org/maxkey/authz/oauth2/provider/userinfo/endpoint/UserInfoEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/metadata/endpoint/MetadataEndpoint.java b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/metadata/endpoint/MetadataEndpoint.java index 6233f3ad1..25196ed6b 100644 --- a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/metadata/endpoint/MetadataEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/metadata/endpoint/MetadataEndpoint.java @@ -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 { diff --git a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/IdpInitEndpoint.java b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/IdpInitEndpoint.java index 21209ae91..ae6d06348 100644 --- a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/IdpInitEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/IdpInitEndpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/LogoutSamlEndpoint.java b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/LogoutSamlEndpoint.java index e2ff8a69c..0631a9b93 100644 --- a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/LogoutSamlEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/LogoutSamlEndpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/SingleSignOnEndpoint.java b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/SingleSignOnEndpoint.java index c869211bb..23f60756a 100644 --- a/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/SingleSignOnEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-saml-2.0/src/main/java/org/maxkey/authz/saml20/provider/endpoint/SingleSignOnEndpoint.java @@ -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); diff --git a/maxkey-protocols/maxkey-protocol-tokenbased/src/main/java/org/maxkey/authz/token/endpoint/TokenBasedAuthorizeEndpoint.java b/maxkey-protocols/maxkey-protocol-tokenbased/src/main/java/org/maxkey/authz/token/endpoint/TokenBasedAuthorizeEndpoint.java index 831fe92fa..9e293b32c 100644 --- a/maxkey-protocols/maxkey-protocol-tokenbased/src/main/java/org/maxkey/authz/token/endpoint/TokenBasedAuthorizeEndpoint.java +++ b/maxkey-protocols/maxkey-protocol-tokenbased/src/main/java/org/maxkey/authz/token/endpoint/TokenBasedAuthorizeEndpoint.java @@ -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{ diff --git a/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LoginEndpoint.java b/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LoginEndpoint.java index ba06114ed..2afc8d829 100644 --- a/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LoginEndpoint.java +++ b/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LoginEndpoint.java @@ -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."); diff --git a/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LogoutEndpoint.java b/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LogoutEndpoint.java index 2d71cc9f7..6b12e4d1a 100644 --- a/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LogoutEndpoint.java +++ b/maxkey-web-maxkey/src/main/java/org/maxkey/web/endpoint/LogoutEndpoint.java @@ -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 {