BastionSSO/config/apidoc.php

76 lines
2.2 KiB
PHP

<?php
return [
'title' => 'Bastion SSO ApiDoc',
'desc' => '统一SSO登录系统 API 文档',
'apps' => [
[
'title' => 'Api接口',
'path' => 'app\Http\Controllers\Api',
'key' => 'api',
],
],
'definitions' => 'app\Http\Controllers\Api\Definitions',
'auto_url' => [
'letter_rule' => 'lcfirst',
'prefix' => '',
],
'auto_register_routes' => true,
'cache' => [
'enable' => false,
],
'auth' => [
'enable' => false,
'password' => '123456',
'secret_key' => 'apidoc#hg_code',
'expire' => 24 * 60 * 60,
],
'params' => [
'header' => [
['name' => 'Authorization', 'type' => 'string', 'require' => true, 'desc' => 'Bearer Token'],
],
'query' => [],
'body' => [],
],
'responses' => [
'success' => [
['name' => 'code', 'desc' => '业务代码', 'type' => 'int', 'require' => 1],
['name' => 'message', 'desc' => '业务信息', 'type' => 'string', 'require' => 1],
['name' => 'data', 'desc' => '业务数据', 'main' => true, 'type' => 'object', 'require' => 1],
],
'error' => [
['name' => 'code', 'desc' => '业务代码', 'type' => 'int', 'require' => 1],
['name' => 'message', 'desc' => '业务信息', 'type' => 'string', 'require' => 1],
],
],
'responses_status' => [
['name' => '200', 'desc' => '请求成功'],
['name' => '401', 'desc' => '登录令牌无效', 'contentType' => ''],
],
'route_prefix' => '/apidoc',
'default_author' => '',
'default_method' => 'GET',
'allowCrossDomain' => false,
'ignored_annitation' => [],
'ignored_methods' => [
'__call',
'middleware',
'getMiddleware',
'callAction',
'authorize',
'authorizeForUser',
'authorizeResource',
'validate',
'validateWith',
'validateWithBag',
],
'database' => [],
'docs' => [],
'generator' => [],
'code_template' => [],
'share' => [
'enable' => false,
'actions' => [],
],
];