https://github.com/cyangle/crystal_client_generator

openapi-generator templates for crystal client
https://github.com/cyangle/crystal_client_generator

Last synced: 6 days ago
JSON representation

openapi-generator templates for crystal client

• Host: GitHub
• URL: https://github.com/cyangle/crystal_client_generator
• Owner: cyangle
• License: apache-2.0
• Created: 2021-11-18T03:09:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-07T20:37:33.000Z (2 months ago)
• Last Synced: 2024-09-07T21:41:53.096Z (2 months ago)
• Language: Mustache
• Size: 2.3 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# crystal_client_generator

Custom OpenAPI Generator templates for generating crystal client libraries.

## What is OpenAPI Generator

[OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (only 3.0 is supported).

OpenAPI Generator supports [User-defined Templates](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md#user-defined-templates).

`crystal_client_generator` provides custom OpenAPI Generator templates for generating crystal client libraries.

This readme is for version 0.3.1

## Usage

You need to have docker installed first with instructions from [here](https://docs.docker.com/get-docker/).

Run script `bin/generate.sh` from project root directory to generate the crystal client library.

`bin/generate.sh` runs OpenAPI Generator from inside a docker container, and mounts project root directory to `/gen` in the container, so you need to specify path arguments relative to project root.

You can place your OpenAPI specification file in folder `local/`, and generate the output to a subfolder in `out/`.

Files and folders under `local/` and `out/` are ignored by git.

Example command to generate google_drive library with api spec file `example_api_specs/google-drive-api-v3-oas3.json`.

```sh

./bin/generate.sh \

  -i example_api_specs/google-drive-api-v3-oas3.json \

  -o out/google_drive \

  --additional-properties=shardName=google_drive,moduleName=GoogleDrive,shardLicense=MIT,shardVersion=3.0.0,shardAuthors=cyangle,shardDescription=Google\ Drive\ V3\ API\ Client

```

The generated code would be written to `out/google_drive`.

## SDKs generated with this repo

[Twilio](https://github.com/cyangle/twilio)

[Google Drive V3](https://github.com/cyangle/google_drive)

[Google Cloud Storage V1](https://github.com/cyangle/google_cloud_storage)