README

This package for laravel converts your json responses to typescript types and interfaces using GPT-3.5 then stores them in the specified directory.

Installation

You can install the package via composer:

composer require benqoder/laravel-typescript-generator

You can publish the config file with:

php artisan vendor:publish --tag="laravel-typescript-gen-config"

This is the contents of the published config file:

return [
    'enabled' => env('TYPESCRIPT_GENERATOR_ENABLED', false),
    'openai_api_key' => env('OPENAI_API_KEY', ''),
    'output_path' => env('TYPESCRIPT_GENERATOR_OUTPUT_PATH', '.typescript-generator'),
];

Usage

Register Typescript generator middleware as the last middleware in app/Http/Kernel.php

    protected $middleware = [
        ...
        \BenQoder\TypescriptGenerator\Middleware\TypescriptGenerator::class,
    ];

When you send request and the response header specifies content-type as "application/json" the Typesceipt interfaces will be generated and placed in "/.typescript-generator" directory or the custom direcory you specify in the config file.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Adinnu Benedict
• All Contributors

License

The MIT License (MIT). Please see License File for more information.