How should top-level array replies be implemented?

[ixnoahlive]

Hi! I'm working on adding coverage for the Housing APIs and ran into an issue.

The entire API is basically built on the idea of responses being objects at the top level, but with Housing two of the three endpoints return an array. Is there a preferred way to implement this or should I just make something up like using a wrapper class or making a special get method for these types of responses?

[Clemintina]

I'd personally make a wrapper class to add useful functions, getters and maps. If you want to make it helper oriented, you can map specific items such as owner to a Map then use .get to fetch them. If the owner is likely to appear multiple times, you can make an owner -> array of houses or owner -> map of each house name. You could even implement getters for each property.

Example:
housing.get(owner).get(housename).getCookies()
housing.get(owner).get(housename).getCreatedAt()

[ixnoahlive]

I'm currently talking about this repo project itself, not my own wrapper. I don't think Hypixel would like Housing to kind of be on its own isolated island considering SkyBlock isn't either. I do like your idea, but I'll see how I can best apply it to the current structure :)

[Clemintina]

Oh, my bad. I thought you weren't sure how to implement it in your own project. I'm sure Hypixel would be okay with it as it creates a better developer experience. Thinking about it, maybe a breaking change with a lot of helpers would be beneficial for the wrapper although Hypixel does seem to prefer the minimalist approach.

[ixnoahlive]

Mhm, will probably settle for some kind of custom reply class in this case to handle weird cases like this. The end experience is most important after all.