具有嵌套架构的类型化REST API

时间:2019-04-20 11:09:27

标签: typescript typescript-generics

我正在尝试使用Typescript编写可向现有REST API发出请求的完整类型代码。该API允许在请求中任意嵌套模型。为简单起见,假设我们只有两个模型UserAddress和一个伪造的getUser。这就是我得到的:

interface User {
    id: string;
    name: string;
    age: number;
    address: Address;
}

interface Address {
    country: string;
    city: string;
}

type UserSelector = {
    id: null;
    name: null;
    age: null;
    address: Partial<AddressSelector>;
};

type AddressSelector = {
    country: null;
    city: null;
};

function getUser<K extends keyof UserSelector>(_fields: Pick<UserSelector, K>): Pick<User, K> {
    // return a mock object, will get from DB in real code
    return {
        id: "1",
        name: "Jean Seberg",
        age: 30,
        address: { country: "FR", city: "Paris" },
    } as Pick<User, K>;
}

const user = getUser({
    //unknownField: null, // SHOULD TYPE ERROR, IT DOES
    id: null,
    age: null,
    address: { country: null },
});

console.log(user.id, user.age, user.address.country);
//console.log(user.name); // SHOULD TYPE ERROR, IT DOES
console.log(user.address.city); // SHOULD TYPE ERROR, IT DOES NOT

如您所见,这不能按预期方式工作,user.address.city应该给出编译类型错误,因为键city不在地址选择器中。很明显为什么它不起作用,但是我不知道如何以通用方式编写,以便它支持任何嵌套级别(带有关系的硬编码类型似乎不是一种选择)。

在Typescript(任何版本)中是否可行?怎么样?

1 个答案:

答案 0 :(得分:0)

类型检查正确。

type UserSelector = {
    id: null;
    name: null;
    age: null;
    address: Partial<AddressSelector>;
};

type AddressSelector = {
    country: null;
    city: null;
};

address的属性UserSelectorPartial,这意味着AddressSelector的所有属性都是可选的,因此如果不显示city也是可以的。 / p>

根据需要,您应该删除Partial,并指定AddressSelector ['country']和AddressSelector ['city']的类型。