api doc

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

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 {

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{
 

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{
 

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{
 

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{
 

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);

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);

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);

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{
 

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 {

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 {
 

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 {
 

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 {

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 {

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);

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);

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);

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{
 

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.");

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 {