Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elomagic/yacog4openapi

Yast Another Code Generator Tool 4 Open API
https://github.com/elomagic/yacog4openapi

codegen delphi generic openapi openapi3

Last synced: about 1 month ago
JSON representation

Yast Another Code Generator Tool 4 Open API

Host: GitHub
URL: https://github.com/elomagic/yacog4openapi
Owner: elomagic
License: apache-2.0
Created: 2022-08-10T13:57:05.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-08-15T16:24:26.000Z (over 2 years ago)
Last Synced: 2024-11-06T02:42:42.621Z (3 months ago)
Topics: codegen, delphi, generic, openapi, openapi3
Language: Python
Homepage:
Size: 28.3 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Yast Another Code Generator Tool 4 OpenAPI

Currently, prototype status

---

[![GitHub tag](https://img.shields.io/github/tag/elomagic/yacog4openapi.svg)](https://github.com/elomagic/yacog4openapi/tags/)

[![GitHub issues](https://img.shields.io/github/issues-raw/elomagic/yacog4openapi)](https://github.com/elomagic/yacog4openapi/issues)

[![Apache 2.0 license](https://img.shields.io/badge/Apache-2.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html)

[![made-with-micropython](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/elomagic/yacog4openapi/graphs/commit-activity)

[![Buymeacoffee](https://badgen.net/badge/icon/buymeacoffee?icon=buymeacoffee&label)](https://www.buymeacoffee.com/elomagic)

## Table of Contents

- [What about?](#what-about?)

- [Installation](#installation)

- [Configuration](#configuration)

- [Using](#using)

- [Contribution](#contribution)

# What About?

This project is currently a small prototype project how to read an Open API file and use a template engine in Python. 

# Installation

All required Python dependencies are declared in the *requirement.txt* file and must be installed with the following 

command by using the Python package manager *Pip*: 

```shell

pip install -r requirements.txt

```

# Configuration

```json5

{

    "input": {

        // Default OpenAPI definition file

        "source": "../test/openapi.json"

    },    

    // Template to use

    "template": "resources/delphi-unit.jinja2",

    // File generated output

    "output": "../out/uRestServiceClient.pas",

    // Open API datatype mappings

    "datatype-map": {

        "number,float":  "Single",

        "number,double": "Double",

        "number,": "Single",

        "integer,in32": "Integer",

        "integer,int64": "Int64",

        "integer,": "Integer",

        "string,byte": "String",

        "string,binary": "String",

        "string,": "String",

        "string,date": "TDate",

        "string,date-time": "TDateTime",

        "string,uuid": "String",

        "boolean,": "Boolean"

    }

}

```

tbc

# Using

## Creating output

### Example

```shell

src/genclient.py --source=test/openapi.json --template=test/delphi-test-example.jinja2 --output=test-output/delphi-unit.pas

```

## Supported parameters

To get an overview of the supported parameters, enter the following command in your shell:

```shell

src/genclient.py --help

```

tbc

# Contribution

tbd