New Generator: Crystal client generator about openapi-generator

[wing328]

@ndbroadbent thanks for becoming a sponsor of openapi-generator.

Looking forward to your PR for the Crystal client generator. If you need help, please let me know.

[ndbroadbent]

Hello! My company has just decided to support the Crystal language. We use openapi-generator, so I would love to work on this and release a Crystal API client for my service. I think it shouldn't be too difficult since the syntax is so similar to Ruby.

(I just realized that I should be supporting openapi-generator as well, so I've also set up a monthly donation on opencollect!)

I'm not sure how much time I can dedicate to this, but I can probably work on it during evenings and weekends. It will also be a great opportunity to learn more about the Crystal language. (I think Crystal would also be the perfect language for building a compiled CLI tool that people can use to interact with my API.)

[ddcprg]

Hi, anyone working on this yet? I may be able to help

[wing328]

@ddcprg I don't think anyone has started on this yet.

Do you mind PM'ing me on Slack so that we can formulate a plan?

https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM

[wing328]

Similar to how some other generators (e.g. R, Lua, PowerShell) are created, we will use the reverse engineering process to create the Crystal client generator.

1. create Crystal petstore client samples (implemented at least 2 endpoints to start with: getPetById, addPet)
2. file a PR to put the client under samples/client/petstore/crystal
3. reverse engineer the templates and the generator (Java class)
4. test the auto-generated code and revise the generator, templates
5. alpha/beta release

Petstore spec:

• OAS v2: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml
• OAS v3: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml

[ddcprg]

@ndbroadbent do you still want to go ahead and contribute this?

[ndbroadbent]

Hi @ddcprg, sorry unfortunately I didn't have time to start working on this! Anyone else can please feel free to take over if you might be interested

[ddcprg]

hi @ndbroadbent no problem, I'll try to take over then although is busy times for me as well

[wing328]

I've filed #8304 to start with. add_pet and get_pet_by_id work and are tested as part of the CI.

It's not perfect. There's still a lot needs to be done and I'll create a TODO list later.

For the time being, please try it out and let me know if you've any feedback.

[wing328]

Closed via #8304