/
apirequest.go
68 lines (62 loc) · 2.07 KB
/
apirequest.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright © 2024 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package ffapi
import (
"net/http"
"reflect"
)
type APIRequest struct {
Req *http.Request
QP map[string]string
QAP map[string][]string
PP map[string]string
FP map[string]string
Filter AndFilter
Input interface{}
Part *Multipart
SuccessStatus int
ResponseHeaders http.Header
AlwaysPaginate bool
}
// Encourage consideration for new APIs of using ItemsResult() - generic and documented, and always returns the same output for all queries
// FilterResult is a helper to transform a filter result into a REST API standard payload
func (r *APIRequest) FilterResult(items interface{}, res *FilterResult, err error) (interface{}, error) {
itemsVal := reflect.ValueOf(items)
if itemsVal.Kind() == reflect.Slice && (r.AlwaysPaginate || (res != nil && res.TotalCount != nil)) {
response := &FilterResultsWithCount{
Items: items,
}
if res != nil {
response.Total = res.TotalCount
}
if itemsVal.Kind() == reflect.Slice {
response.Count = int64(itemsVal.Len())
}
return response, err
}
return items, err
}
// ItemsResult is a helper to transform a filter result into a REST API standard payload
func ItemsResult[T any](items []T, res *FilterResult, err error) (*ItemsResultTyped[T], error) {
response := &ItemsResultTyped[T]{
Items: items,
}
if res != nil {
response.Total = res.TotalCount
}
response.Count = len(items)
return response, err
}