vortechron/laravel-data-openapi-generator

Generate OpenAPI specification from Laravel routes and Laravel Data objects.

Maintainers

Details

github.com/vortechron/laravel-data-openapi-generator

Source

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 16

dev-main 2024-05-27 12:37 UTC

Requires

Requires (Dev)

MIT 4ec6f212de8f1a1ffef6905c37c62e444c71d600

  • Amirul Adli <sayaamiruladli.woop@gmail.com>

This package is auto-updated.

Last update: 2025-02-27 14:19:40 UTC

README

Generate OpenAPI specification from Laravel routes and Laravel Data objects

Install

Add composer repository

In composer.json add this repository:

    "repositories": [
        {
            "type": "github",
            "url": "https://github.com/vortechron/laravel-data-openapi-generator"
        }
    ],

Install

composer require xolvio/laravel-data-openapi-generator

Optional

Version

Add a app.version config in app.php to set the version in the openapi specification:

    'version' => env('APP_VERSION', '1.0.0'),

Vite PWA config

If using vite-plugin-pwa, make sure to exclude '/api/' routes from the serviceworker using this config:

VitePWA({
	workbox: {
		navigateFallbackDenylist: [new RegExp("/api/.+")],
	},
});

Vue page

<route lang="json">
{
	"meta": {
		"public": true
	}
}
</route>

<template>
	<iframe
		:src="url"
		style="width: calc(100vw - 40px);height: calc(100vh - 80px); border: none;"
	/>
</template>

<script lang="ts" setup>
const url = `${import.meta.env.VITE_APP_URL}/api/openapi`;
</script>

Usage

Config

php artisan vendor:publish --tag=openapi-generator-config

Generate

php artisan openapi:generate

View

Swagger available at APP_URL/api/openapi