Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: An opinionated and statically-typed TypeScript SDK generator

easysdk.xyz

Post reply on HN
Print view View original

11–20 of 47 posts

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#12

Post by swatcoder »

jzig wrote: post #4
fcoury wrote: post #2

Congrats on the launch! I think it might be interesting to provide some examples without the need to upload a schema, since I assume most people playing with it won't have one ready right off the bat.

You can go to the Swagger Editor [1], download the default Pet Store schema as a JSON file, and upload it here to see an example in action. [1]: https://editor.swagger.io/ Edit: Apparently their URLs are public, so here is the Pet Store schema I uploaded https://easysdk.xyz/sdk/openapi.json-a09be341882b7aa7b87eb40...

`[k: string]: unknown;`

It looks like all the data interfaces add this, which will (a) happily swallow typos, and (b) give you no warning that you might be pushing extra (i.e. private) data to the remote.

I understand that some people like the flexibility it provides, but it would be nice for that to be an option. There's no way I'd use the generated types with that, and the tool has a lot less value if I still have to go in and modify its output by hand.

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#14

Post by AChelikani »

Congrats Sagar and team - excited that someone is working on this! OpenAPI generator and swagger codegen has almost always produced unreadable and unusable SDKs for me, especially when my schema contains any model composition or polymorphism with allOf/anyOf/oneOf.

Have you guys written this entirely from scratch or done your own mustache templating on top of openapi-generator?

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#15

Post by simplesager »

AChelikani wrote: post #14

Congrats Sagar and team - excited that someone is working on this! OpenAPI generator and swagger codegen has almost always produced unreadable and unusable SDKs for me, especially when my schema contains any model composition or polymorphism with allOf/anyOf/oneOf. Have you guys written this entirely from scratch or done your own mustache templating on top of openapi-generator?

We used a forked version of https://github.com/readmeio/oas to help dereference `$ref` statements, but other than that this is entirely hand-written: The Typescript `factory` AST API + `prettier` for formatting.

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#16

Post by ThomasRooney »

swatcoder wrote: post #12
jzig wrote: post #4

Earlier quoted context omitted.

You can go to the Swagger Editor [1], download the default Pet Store schema as a JSON file, and upload it here to see an example in action. [1]: https://editor.swagger.io/ Edit: Apparently their URLs are public, so here is the Pet Store schema I uploaded https://easysdk.xyz/sdk/openapi.json-a09be341882b7aa7b87eb40...

`[k: string]: unknown;` It looks like all the data interfaces add this, which will (a) happily swallow typos, and (b) give you no warning that you might be pushing extra (i.e. private) data to the remote. I understand that some people like the flexibility it provides, but it would be nice for that to be an option. There's no way I'd use the generated types with that, and the tool has a lot less value if I still have…

This is a really good point. The generated SDK is configured to allow a super-set of the API request body to hit the backend, which could expose unnecessary data fields if passed in by client code.

It comes because we’re a bit pragmatic: if a user doesn’t specify their full data structure in their OpenAPI specification, and we can’t generate a strict type, we allow an arbitrary structure to reach the backend. In our experience the hard bit isn’t really writing the SDK, it’s making and maintaining a good OpenAPI spec (hence part of the commercial product we’re moving towards is the ability to generate a strict OpenAPI specification directly from handler code / traffic analysis in a backend server). Your concern is totally valid, and this is something we will make configurable.

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#19

Post by benbristow »

kbanman wrote: post #13

Congrats on launching! For anyone looking for more (open-source) alternatives, here's one I just discovered today: https://microsoft.github.io/kiota/

I've had success with NSwag for generating both TypeScript and C# clients. Highly customisable - maybe too customisable with the config being quite complex - there's CLI & GUI tools to generate configs though.

https://github.com/RicoSuter/NSwag

We use the C# client generator in our public sector project and package the results up within Nuget, works a treat.

Re: Show HN: An opinionated and statically-typed TypeScript SDK generator

#20

Post by benbristow »

yodon wrote: post #5

Nice! Any plans for generating C# sdk's?

I feel a bit spammy as I just commented on a comment a bit higher with the same thing, but NSwag will do the trick for you.

https://github.com/RicoSuter/NSwag

Works a treat and is open-source, integrates nicely with ASP WebAPI projects. Can even generate TypeScript clients with a choice of HTTP library (axios/fetch etc.) or even an Angular based client.

Post reply on HN