Initial version

Author: RobertGroot

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+.php-cs.cache

README.md

@@ -0,0 +1,87 @@
+# OpenAPI Generator using Laravel Data
+
+Generate OpenAPI specification from Laravel routes and Laravel Data objects
+
+# Install
+
+## Add composer repository
+
+In `composer.json` add:
+
+```json
+    "repositories": [
+        {
+            "type": "gitlab",
+            "url": "https://gitlab.com/xolvio-nl/laravel-data-openapi-generator"
+        }
+    ],
+```
+
+## Add GitLab auth token
+
+1. Create Auth token with api or api_read rights: https://gitlab.com/-/profile/personal_access_tokens
+2. Run `composer config --global --auth gitlab-token.gitlab.com TOKEN_HERE`
+
+## Install
+
+`composer require xolvio/laravel-data-openapi-generator:dev-main`
+
+# Optional
+
+## Version
+
+Add a `app.version` config in `app.php` to set the version in the openapi specification:
+```php
+    '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:
+
+```ts
+VitePWA({
+    workbox: {
+        navigateFallbackDenylist: [
+            new RegExp('/api/.+'),
+        ],
+    },
+})
+```
+
+## Vue page
+
+```vue
+<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`

composer.json

@@ -0,0 +1,45 @@
+{
+    "name": "xolvio/laravel-data-openapi-generator",
+    "description": "Generate OpenAPI specification from Laravel routes and Laravel Data objects.",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Xolvio\\OpenApiGenerator\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Xolvio\\OpenApiGenerator\\OpenApiServiceProvider"
+            ]
+        }
+    },
+    "authors": [
+        {
+            "name": "Robert Groot",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "scripts": {
+        "format": [
+            "@php ./vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --verbose --config=./php-cs.php --path-mode=intersection . --ansi"
+        ],
+        "larastan": [
+            "vendor/bin/phpstan analyse"
+        ]
+    },
+    "require": {
+        "spatie/laravel-data": "^1",
+        "laravel/framework": "^8|^9",
+        "phpdocumentor/reflection-docblock": "^5.3",
+        "spatie/invade": "^1.0"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.8",
+        "nunomaduro/larastan": "^2.1",
+        "orchestra/testbench": "^7.5"
+    }
+}