datamodel-code-generator VS swagger-typescript-api

Like generating pydantic models or dataclasses for an OpenAPI schema? I haven't needed to go in that direction myself, but this[0] looks promising!

Apologies if I've misunderstood your comment

https://koxudaxi.github.io/datamodel-code-generator/

I'm sorry, but you have completely misunderstood the purpose of Open API.

It is not a specification to define your business logic classes and objects -- either client or server side. Its goal is to define the interface of an API, and to provide a single source of truth that requests and responses can be validated against. It contains everything you need to know to make requests to an API; code generation is nice to have (and I use it myself, but mainly on the server side, for routing and validation), but not something required or expected from OpenAPI

For what it's worth, my personal preferred workflow to build an API is as follows:

1. Build the OpenAPI spec first. A smaller spec could easily be done by hand, but I prefer using a design tool like Stoplight [0]; it has the best Web-based OpenAPI (and JSON Schema) editor I have encountered, and integrates with git nearly flawlessly.

2. Use an automated tool to generate the API code implementation. Again, a static generation tool such as datamodel-code-generator [1] (which generates Pydantic models) would suffice, but for Python I prefer the dynamic request routing and validation provided by pyapi-server [2].

3. Finally, I use automated testing tools such as schemathesis [3] to test the implementation against the specification.

[0] https://stoplight.io/

[1] https://koxudaxi.github.io/datamodel-code-generator/

[2] https://pyapi-server.readthedocs.io

[3] https://schemathesis.readthedocs.io

The site also provide a link to the github repo of the underlying program.

Not sure who owns/hosts the site, but its based on this github repo.

That's what datamodel-code-generator propose.

had generally good experience creating typed wrappers for api's with json-schema-to-pydantic[0] converter

[0] https://github.com/koxudaxi/datamodel-code-generator

To save you some work, if you have already an OpenAPI specification at hand, you can use datamodel-code-generator to generate your Pydantic models from the spec.

And there are code generators for it! https://github.com/koxudaxi/datamodel-code-generator/

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.