github.heygears.com/openimsdk/tools@v0.0.49/apiresp/gin.go (about)

     1  // Copyright © 2023 OpenIM. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package apiresp
    16  
    17  import (
    18  	"net/http"
    19  
    20  	"github.com/gin-gonic/gin"
    21  )
    22  
    23  const (
    24  	ginApiResponseKey = "gin_api_response_key"
    25  )
    26  
    27  func ginJson(c *gin.Context, resp *ApiResponse) {
    28  	c.Set(ginApiResponseKey, resp)
    29  	c.JSON(http.StatusOK, resp)
    30  }
    31  
    32  func GetGinApiResponse(c *gin.Context) *ApiResponse {
    33  	val, ok := c.Get(ginApiResponseKey)
    34  	if !ok {
    35  		return nil
    36  	}
    37  	resp, _ := val.(*ApiResponse)
    38  	return resp
    39  }
    40  
    41  func GinError(c *gin.Context, err error) {
    42  	ginJson(c, ParseError(err))
    43  }
    44  
    45  func GinSuccess(c *gin.Context, data any) {
    46  	ginJson(c, ApiSuccess(data))
    47  }