examples_test.go

package restapi_test

import (
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"

	"github.com/Arhius/restapi"
	"github.com/gin-gonic/gin"
)

// Example_success shows how to write a successful JSON response.
func Example_success() {
	gin.SetMode(gin.TestMode)
	w := httptest.NewRecorder()
	c, _ := gin.CreateTestContext(w)
	c.Request = httptest.NewRequest(http.MethodGet, "/", nil)

	restapi.Success(c, http.StatusOK, map[string]string{"name": "alice"})

	var body restapi.ResponseBody
	_ = json.Unmarshal(w.Body.Bytes(), &body)
	data := body.Data.(map[string]any)
	fmt.Printf("status=%d name=%s\n", w.Code, data["name"])
	// Output: status=200 name=alice
}

// ExampleAPI_Error shows how to write an error response that maps to an HTTP
// status via the registry.
func ExampleAPI_Error() {
	gin.SetMode(gin.TestMode)
	w := httptest.NewRecorder()
	c, _ := gin.CreateTestContext(w)
	c.Request = httptest.NewRequest(http.MethodGet, "/", nil)

	restapi.Default().Error(c, restapi.CodeNotFound, restapi.WithMessage("user not found"))

	var body restapi.ResponseBody
	_ = json.Unmarshal(w.Body.Bytes(), &body)
	fmt.Printf("status=%d code=%d msg=%s\n", w.Code, body.Errors[0].Code, body.Errors[0].Message)
	// Output: status=404 code=1003 msg=user not found
}

// Example_pagination shows using the offset pagination helpers.
func Example_pagination() {
	req := restapi.OffsetPaginationRequest{Limit: 10, Offset: 20}
	if err := req.Validate(); err != nil {
		fmt.Println(err)
		return
	}
	resp := req.Response(1000)
	fmt.Printf("limit=%d offset=%d total=%d\n", resp.Limit, resp.Offset, resp.Total)
	// Output: limit=10 offset=20 total=1000
}