crd-to-sample-yaml VS openapi-generator

Hello everyone!

Previously I wrote about cty[^1] that can be used to generate valid YAML samples from a CRD ( now, including things like, valid Pattern generated random string, enums, default values, minimum int, minimum number of items.. etc ).

It also has a website that can be used to achieve the same thing here: https://crdtoyaml.com/

This update https://github.com/Skarlso/crd-to-sample-yaml/releases/tag/v... brings a feature with it, which I think is super cool. If not, well, then no. :)

Basically, inspired by `helm unittest` the user can define a test like this:

    suite: test aws clusters infrastructure crds

Hello peeps.

I’ve wrote a tool to nicely display crds. I know of docs.crds how is this different? You can paste in the crd and it will generate a sample yaml to boot and you don’t need to point it at a repository. Also it has a cli version. Here is the repo https://github.com/Skarlso/crd-to-sample-yaml.

I hope someone finds this useful. Any feedback is always appreciated. :) Thanks.

Here is the link.

So, I wrote a tool. :D https://github.com/Skarlso/crd-to-sample-yaml

OpenAPI Generator

Let’s learn how to generate an API client for an Angular project using the open-source OpenAPI Generator program. The OpenAPI Generator project offers a CLI for generating API client modules for multiple language targets by importing a YAML/JSON API specification file.

Did you try to use https://github.com/OpenAPITools/openapi-generator directly?

OpenAPI Generator is a versatile tool that emerged as a fork of Swagger Codegen, offering enhanced support and features. It allows developers to generate API client libraries, server stubs, and documentation for over 30 programming languages.

Since @tanstack/react-query and swr give all control of the request to the user, the API automation solution is provided by third-party request tools. For example, axios and fetch can automatically generate request codes through openapi-generator or @openapitools/openapi-generator-cli.

You would use OpenAPI (formerly Swagger) [1] for that, which includes JSONSchema for data types but also adds specs for defining REST apis. There are plenty of generators and other tools that work with OpenAPI [2]

[1] https://www.openapis.org/

[2] https://openapi-generator.tech/

I found some "tricks" to write less code, hence less code to maintain if there are any changes. Also less code with bugs just by changing the inputs.

For example, OpenAPI spec file + OpenAPI generator (https://github.com/OpenAPITools/openapi-generator). Any changes in the OpenAPI spec are reflected in the final code with a build step.

Another example: MapStruct (https://mapstruct.org/) to avoid passing data from Entity classes to DTO and back. Saves looots of boilerplate code.

Which are your tricks?

Disclaimer: We're an early adopter of Stainless at Mux.

I've spent more of my time than I'd like to admit managing both OpenAPi spec files [1] and fighting with openapi-generator [2] than any sane person should have to. While it's great having the freedom to change the templates an thus generated SDKs you get with using that sort of approach, it's also super time consuming, and when you have a lot of SDKs (we have 6 generated SDKs), in my experience it needs someone devoted to managing the process, staying up with template changes etc.

Excited to see more SDK languages come to Stainless!

[1] https://www.mux.com/blog/an-adventure-in-openapi-v3-api-code...

[2] https://github.com/OpenAPITools/openapi-generator

As a result, the following specification can be used to generate clients in a number of different languages via OpenAPI Generator.