Grails REST API - Render JSON с пейджинговыми, метаданными и настраиваемыми полями из параметров

Я ищу лучший способ создать пользовательский ответ JSON для RESTful API в Grails на основе этой презентации Design Beautiful REST + JSON API by Les Hazlewood.

Вот мой класс домена

class TaxiType {

    Date dateCreated, lastUpdated
    String description
    User createdBy

    static hasMany = [taxis: Taxi]

    static constraints = {
    }
}

Желаемый формат ответа для списка

{
  "meta": {
    "href": "https://api.mydomain.com/taxi-types",
    "otherData": "..."
  },
  "paging": {
    "offset": 0,
    "limit": 10,
    "total": 100,
    "first": "https://api.mydomain.com/taxi-types?offset=0&limit=10",
    "previous": null,
    "next": "https://api.mydomain.com/taxi-types?offset=90&limit=10",
    "last": "https://api.mydomain.com/taxi-types?offset=90&limit=10"
  },
  "data": [
    {
      "href": "https://api.mydomain.com/taxi-types/1",
      "id": 1,
      "description": "description 1",
      "taxis": {
        "href": "https://api.mydomain.com/taxi-types/1/taxis"
      }
    },
    ...
  ]
}

TaxiTypeController.groovy

def index(Integer limit) {
    params.max = Math.min(limit ?  : 10, 100)
        params.offset = params ? .offset ? .toInteger()
        withFormat {
        json {
            respond TaxiType.list(params),
            [includes : includeFields,
                paging : [total : TaxiType.count(), limit : params ? .max, offset : params ? .offset ?  : 0]
            ]
        }
    }
}
private getIncludeFields() {
    params.fields ? .tokenize(', ')
}

SumoJsonCollectionRenderer.groovy

class SumoJsonCollectionRenderer extends JsonCollectionRenderer {
    SumoJsonCollectionRenderer(Class componentType) {
        super(componentType)
    }
    public SumoJsonCollectionRenderer(Class componentType, MimeType...mimeTypes) {
        super(componentType, mimeTypes)
    }
     @ CompileStatic(SKIP)
     @ Override
    protected void renderJson(object, RenderContext context) {
        log.debug(object)
        log.debug(object.size())
        log.debug(object.getTotalCount())
        Map tObject = ['data' : object]
        if (context.arguments ? .paging) {
            tObject['paging'] = context ? .arguments ? .paging
        }
        super.renderJson(tObject, context)
    }
}

Обязательные функции:

1) Пользователи API должны иметь возможность получать только требуемые поля (частичные представления)

GET https://api.mydomain.com/taxi-types??fields=id,description,taxis

желаемый ответ для этого запроса должен быть

{
    "meta" : {...}
    "paging" : {...}
    "data" : [{
            "href" : "https://api.mydomain.com/taxi-types/1",
            "id" : 1,
            "description" : "Taxi Type1",
            "taxis" : [{
                    "href" : "https://api.mydomain.com/taxis/123"
                },
                ...
            ]
        },
        ...
    ]
}

То, что я получаю, было

{
    "data" : [{
            "id" : 1,
            "description" : "Taxi Type1",
            "taxis" : [{
                    "class" : "com.domain.project.Taxi",
                    "id" : 1
                }
            ]
        },
        ...
    ],
    "paging" : {
        "total" : 80,
        "limit" : 10,
        "offset" : 0
    }
}

Я ответил на этот вопрос метаданные рендеринга для разбивки на страницы с помощью указателей Graind RestoverController index/search.

Но все равно нужно включать ссылки для first, previous, next & last в пейджинге, как указано в требуемом формате выше.

2) Настройка вывода

например свойство taxis с отношением hasMany должно отображаться по умолчанию как

"taxis": {
    "href": "https://api.mydomain.com/taxis/12345"
}

и если пользователь предпочитает разворачивать свойство taxis, например: GET /taxi-types?expand=taxis, формат JSON должен быть

"taxis": {
    "href": "https://api.mydomain.com/taxis/12345"
    "name": "Taxi name",
    "type": "https://api.mydomain.com/taxi-types/1"
    ...
}

3) Добавьте объект meta ко всем ответам

"meta": {
     "href": "https://api.mydomain.com/taxi-types",
     ...
}

Я попробовал Json Marshaller настроить ответ. Вот мой код Marshaller

JSON.registerObjectMarshaller(TaxiType) {TaxiType taxiType->
    return [
        id : taxiType ? .id,
        description : taxiType ? .description
    ]
}

но он всегда отображает с этими двумя свойствами в возвратном массиве id & description, даже если мне нужны другие свойства, такие как taxis.

Как выше 3 требования могут быть реализованы?. Спасибо заранее.

Ответ 1

Я создал плагин для grails 3, который позволяет добавлять к вашему apis разбивку на страницы, пользовательские метаданные и другие полезные функции. Вы можете добавить функции HAL с помощью LinkGenerators, а также с моим плагином.