vortechron/laravel-data-openapi-generator

从Laravel路由和Laravel数据对象生成OpenAPI规范。

维护者

详情

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

来源

安装: 2

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 10

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: 2024-09-27 13:23:16 UTC

README

从Laravel路由和Laravel数据对象生成OpenAPI规范

安装

添加Composer仓库

在 composer.json 中添加此仓库

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

安装

composer require xolvio/laravel-data-openapi-generator

可选

版本

在 app.php 中添加 app.version 配置以在OpenAPI规范中设置版本

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

Vite PWA配置

如果使用 vite-plugin-pwa，请确保使用此配置排除 '/api/' 路由从serviceworker

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

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>

用法

配置

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

生成

php artisan openapi:generate

查看

Swagger可在 APP_URL/api/openapi 中查看