update comments

Author: LyricTian

const.go

@@ -1,33 +1,28 @@
 package oauth2
 
-// ResponseType Response Type
+// ResponseType the type of authorization request
 type ResponseType string
 
+// define the type of authorization request
 const (
-	// Code Authorization code type
-	Code ResponseType = "code"
-	// Token Token type
+	Code  ResponseType = "code"
 	Token ResponseType = "token"
 )
 
 func (rt ResponseType) String() string {
 	return string(rt)
 }
 
-// GrantType Authorization Grant
+// GrantType authorization model
 type GrantType string
 
+// define authorization model
 const (
-	// AuthorizationCode Authorization Code
-	AuthorizationCode GrantType = "authorization_code"
-	// PasswordCredentials Resource Owner Password Credentials
+	AuthorizationCode   GrantType = "authorization_code"
 	PasswordCredentials GrantType = "password"
-	// ClientCredentials Client Credentials
-	ClientCredentials GrantType = "clientcredentials"
-	// Refreshing Refresh Token
-	Refreshing GrantType = "refreshtoken"
-	// Implicit Implicit Grant
-	Implicit GrantType = "__implicit"
+	ClientCredentials   GrantType = "clientcredentials"
+	Refreshing          GrantType = "refreshtoken"
+	Implicit            GrantType = "__implicit"
 )
 
 func (gt GrantType) String() string {

generate.go

@@ -3,19 +3,19 @@ package oauth2
 import "time"
 
 type (
-	// GenerateBasic Provide the basis of the generated token data
+	// GenerateBasic provide the basis of the generated token data
 	GenerateBasic struct {
-		Client   ClientInfo // The client information
-		UserID   string     // The user id
-		CreateAt time.Time  // Creation time
+		Client   ClientInfo
+		UserID   string
+		CreateAt time.Time
 	}
 
-	// AuthorizeGenerate Generate the authorization code interface
+	// AuthorizeGenerate generate the authorization code interface
 	AuthorizeGenerate interface {
 		Token(data *GenerateBasic) (code string, err error)
 	}
 
-	// AccessGenerate Generate the access and refresh tokens interface
+	// AccessGenerate generate the access and refresh tokens interface
 	AccessGenerate interface {
 		Token(data *GenerateBasic, isGenRefresh bool) (access, refresh string, err error)
 	}

manage.go

@@ -4,44 +4,44 @@ import (
 	"time"
 )
 
-// TokenGenerateRequest Provide to generate the token request parameters
+// TokenGenerateRequest provide to generate the token request parameters
 type TokenGenerateRequest struct {
-	ClientID       string        // The client information
-	ClientSecret   string        // The client secret
-	UserID         string        // The user id
-	RedirectURI    string        // Redirect URI
-	Scope          string        // Scope of authorization
-	Code           string        // Authorization code
-	Refresh        string        // Refreshing token
-	AccessTokenExp time.Duration // Access token expiration time (in seconds)
+	ClientID       string
+	ClientSecret   string
+	UserID         string
+	RedirectURI    string
+	Scope          string
+	Code           string
+	Refresh        string
+	AccessTokenExp time.Duration
 }
 
-// Manager Authorization management interface
+// Manager authorization management interface
 type Manager interface {
-	// Check the interface implementation
+	// check the interface implementation
 	CheckInterface() (err error)
 
-	// Get the client information
+	// get the client information
 	GetClient(clientID string) (cli ClientInfo, err error)
 
-	// Generate the authorization token(code)
+	// generate the authorization token(code)
 	GenerateAuthToken(rt ResponseType, tgr *TokenGenerateRequest) (authToken TokenInfo, err error)
 
-	// Generate the access token
+	// generate the access token
 	GenerateAccessToken(rt GrantType, tgr *TokenGenerateRequest) (accessToken TokenInfo, err error)
 
-	// Refreshing an access token
+	// refreshing an access token
 	RefreshAccessToken(tgr *TokenGenerateRequest) (accessToken TokenInfo, err error)
 
-	// Use the access token to delete the token information
+	// use the access token to delete the token information
 	RemoveAccessToken(access string) (err error)
 
-	// Use the refresh token to delete the token information
+	// use the refresh token to delete the token information
 	RemoveRefreshToken(refresh string) (err error)
 
-	// According to the access token for corresponding token information
+	// according to the access token for corresponding token information
 	LoadAccessToken(access string) (ti TokenInfo, err error)
 
-	// According to the refresh token for corresponding token information
+	// according to the refresh token for corresponding token information
 	LoadRefreshToken(refresh string) (ti TokenInfo, err error)
 }

manage/config.go

@@ -4,9 +4,9 @@ import "time"
 
 // Config authorization configuration parameters
 type Config struct {
-	// access token expiration time (in seconds)
+	// access token expiration time
 	AccessTokenExp time.Duration
-	// refresh token expiration time(in seconds)
+	// refresh token expiration time
 	RefreshTokenExp time.Duration
 	// whether to generate the refreshing token
 	IsGenerateRefresh bool

model.go

@@ -3,74 +3,44 @@ package oauth2
 import "time"
 
 type (
-	// ClientInfo The client information model interface
+	// ClientInfo the client information model interface
 	ClientInfo interface {
-		// The client id
 		GetID() string
-		// The client secret
 		GetSecret() string
-		// The client domain
 		GetDomain() string
-		// The extension data related to the client
 		GetExtraData() interface{}
 	}
 
-	// TokenInfo The token information model interface
+	// TokenInfo the token information model interface
 	TokenInfo interface {
-		// Get client id
 		GetClientID() string
-		// Set client id
 		SetClientID(string)
-		// Get user id
 		GetUserID() string
-		// Set user id
 		SetUserID(string)
-		// Get Redirect URI
 		GetRedirectURI() string
-		// Set Redirect URI
 		SetRedirectURI(string)
-		// Get Scope of authorization
 		GetScope() string
-		// Set Scope of authorization
 		SetScope(string)
 
-		// Get Authorization code
 		GetCode() string
-		// Set Authorization code
 		SetCode(string)
-		// Get Create Time
 		GetCodeCreateAt() time.Time
-		// Set Create Time
 		SetCodeCreateAt(time.Time)
-		// Get The lifetime in seconds of the authorization code
 		GetCodeExpiresIn() time.Duration
-		// Set The lifetime in seconds of the authorization code
 		SetCodeExpiresIn(time.Duration)
 
-		// Get Access Token
 		GetAccess() string
-		// Set Access Token
 		SetAccess(string)
-		// Get Create Time
 		GetAccessCreateAt() time.Time
-		// Set Create Time
 		SetAccessCreateAt(time.Time)
-		// Get The lifetime in seconds of the access token
 		GetAccessExpiresIn() time.Duration
-		// Set The lifetime in seconds of the access token
 		SetAccessExpiresIn(time.Duration)
 
-		// Get Refresh Token
 		GetRefresh() string
-		// Set Refresh Token
 		SetRefresh(string)
-		// Get Create Time
 		GetRefreshCreateAt() time.Time
-		// Set Create Time
 		SetRefreshCreateAt(time.Time)
-		// Get The lifetime in seconds of the access token
 		GetRefreshExpiresIn() time.Duration
-		// Set The lifetime in seconds of the access token
 		SetRefreshExpiresIn(time.Duration)
 	}
 )

models/client.go

@@ -1,10 +1,10 @@
 package models
 
-// Client Client model
+// Client client model
 type Client struct {
-	ID     string // The client id
-	Secret string // The client secret
-	Domain string // The client domain
+	ID     string
+	Secret string
+	Domain string
 }
 
 // GetID The client id