k8s-openapi VS tsoa

It's called sans-io in Python land, which is where I heard it first.

https://sans-io.readthedocs.io/

I did it for one of my projects back in 2018 https://github.com/Arnavion/k8s-openapi/commit/9a4fbb718b119...

Another option is to implement your API in a sans-io form. Since k8s-openapi was mentioned (albeit for a different reason), I'll point out that its API gave you a request value that you could send using whatever sync or async HTTP client you want to use. It also gave you a corresponding function to parse the response, that you would call with the response bytes however you got them from your client.

https://github.com/Arnavion/k8s-openapi/blob/v0.19.0/README....

(Past tense because I removed all the API features from k8s-openapi after that release, for unrelated reasons.)

Macro expansion is slow, but only noticeably in the specific situation of a) third-party proc macros, b) a debug build, and c) a few thousand invocations of said proc macros. This is because debug builds compile proc macros in debug mode too, so while the macro itself compiles quickly (because it's a debug build), it ends up running slowly (because it's a debug build).

I know this from observing this on a mostly auto-generated crate that had a couple of thousand types with `#[derive(serde::)]` on each. [1]

This doesn't affect most users, because first-party macros like `#[derive(Debug)]` etc are not slow because they're part of rustc and are thus optimized regardless of the profile, and even with third-party macros it is unlikely that they have thousands of invocations. Even if it is* a problem, users can opt in to compiling just the proc macros in release mode. [2]

[1]: https://github.com/Arnavion/k8s-openapi/issues/4

[2]: https://github.com/rust-lang/cargo/issues/5622

>OpenAPI Generator allows generation of API client libraries from OpenAPI Specs

It does, but the generated code can be very shitty for some combinations of spec and output language. I maintain Rust bindings for the Kubernetes API server's API, and I chose to write my own code generator instead. The README at https://github.com/Arnavion/k8s-openapi has more details.

k8s_openapi - https://github.com/Arnavion/k8s-openapi

For example: I have a routine that checks the value of (from k8s-openapi): Ingress -> IngressStatus -> LoadBalancerStatus -> Vec[0] -> String

As the maintainer of the Rust bindings that the library used in the article (kube) is backed by, I can confirm that Kubernetes' openapi spec requires a lot of Kubernetes-specific handling to generate a good client than generic openapi generators do not provide.

See https://github.com/Arnavion/k8s-openapi/blob/master/README.m... for a full description.

I also confirm that I keep it up-to-date with Kubernetes releases and have been doing so for the ~3 years that it's been around. Not just the minor ones every few months, but even the point ones; these days the latter usually only involves updating the test cases instead of code changes and they're done within a few hours of the upstream release.

Tsoa is a popular TypeScript framework similar to Goa that you may encounter in the OpenAPI ecosystem. Speakeasy has a tutorial for it, too.

Currently i am using TSOA and loving it, it gives you automatic Open API specs and data validation based on typescript interfaces. I have used Nest on previous projects but I personally don't like the decorators hell that comes with Nest, and raw express/fastify are ok and easy to use but a pain in the ass on big projects to keep swagger, validations, interfaces and DTOs all in sync.

I'm curious if anyone here has played around with or used TSOA (https://github.com/lukeautry/tsoa)?

If you decide to go with Express/Typescript I would definitely check out TSOA. It's a nice way to build backend APIs with auto documentation.

We are using TSOA to generate the docs from the code, works pretty well. https://github.com/lukeautry/tsoa

This is the best project I’ve found to that for that - https://github.com/lukeautry/tsoa. Uses decorators mainly.

If there are other such projects, please share.

Hello, In the last month I built a REST API template in Typescript to quickly bootstrap new projects, I tried to use the most updated modules available, I've also included a "todo" sample just to showcase how all the things work together, the main modules that I've used are: - expressjs + tsoa that allows to easily generate the OpenAPI spec without any additional steps (just declare your controllers via typescript) - class-validator to validate body requests (this is also useful as the OpenAPI will be automatically generated based on the classes that you define) - Jest for testing, I've included also unit and integrations test samples with an in-memory database

Have a look at [TSOA[(https://github.com/lukeautry/tsoa). While far from perfect (I am on the lookout to find a better solution), gets the job done. And generating the entire routing is a pretty neat trick, so that's also that.

tsoa Lighter weight, but also great.