json-schema-to-typescript VS swagger-typescript-api

Compile JSONSchema to TypeScript type declarations

Nice! Lots of tricky edge cases to do this right: there’s ambiguity in the JSON Schema spec, version-to-version changes, many popular community conventions that don’t adhere to the spec, etc. Feel free to check out the tests to understand some of these: https://github.com/bcherny/json-schema-to-typescript (shameless plug — I have maintained this library for a number of years).

jsonnet is my go-to language for anything related to configuration, after having tried json, yaml, TS, edn, and tasting dhall and toml. It addresses all problems in the article and more.

the composition strikes a good balance between extensiveness and ease of use.

the generated json leads to easy and portable data, and if you write jsonschemas from jsonnet, tools like json-schema-to-typescript [1] make it easy to import a consistent interface, and almost every language has a reasonably up-to-date validation library.

[1] https://github.com/bcherny/json-schema-to-typescript

Take a look at https://github.com/bcherny/json-schema-to-typescript, too. I used it successfully at a previous job. IIRC, I had to write some code to convert OpenAPI to JSON Schema but it wasn’t onerous

If you're using OpenAPI, you could use this to generate TypeScript interfaces:

https://github.com/bcherny/json-schema-to-typescript

It works really well

I'm messing around with a process to convert JSON schemas to TypeScript interfaces using json-schema-to-typescript. I have a little under 900 JSON files each containing a schema, totaling about 3.5 MB.

json-schema-to-typescript

RESTful APIs via swagger-typescript-api

TypeScript API generator via Swagger scheme

You said it yourself — the “official” generator is awful and very hard to modify or extend (well, you didn’t say that, but I’m saying it) and while there are many alternatives, they’re not always easy to find. I had some success with swagger-typescript-api[1], but eventually got tired of it and wrote my own generator. Despite looking around quite a bit at what’s available, I never heard of openapi-codegen, which looks quite good.

[1]: https://github.com/acacode/swagger-typescript-api

A lot of APIs nowadays have a Swagger / OpenAPI spec. You can autogenerate types from that using tools like swagger-typescript-api.

With such a contract your BE team should provide a https://swagger.io/tools/swagger-ui/ where the API definition can easily be viewed and tested. Also you can use generators to basically generate a boilerplate (types for all models, functions for all requests) for the entire API based on a contract: https://github.com/acacode/swagger-typescript-api This his already saved me months of work.. great tool.

If your backend is using Swagger, I'd highly recommend using the package swagger-typescript-api. It auto-generates your types and endpoints for you, based on a swagger.json file, which then simplifies where I store my API calls. The flexibility of this is that I can use these API calls in components, classes, Vuex, etc., and I'm not tied to something that I have to maintain as a UI dev.

If your backend is able to generate Swagger/OpenAPI JSON, you can use https://github.com/acacode/swagger-typescript-api to generate both TypeScript interfaces and an API client from the Swagger JSON.