Files
sam-api/app/Swagger/v1/SAMInfo.php

35 lines
1.1 KiB
PHP
Raw Normal View History

<?php
namespace App\Swagger\v1;
/**
* @OA\Info(
* version="1.0.0",
* title="SAM API Documentation",
* description="===============================<br><strong>[공통 에러 응답 포맷]</strong><br>400: 필수 파라미터 누락<br>401: 인증 실패<br>403: 권한 없음<br>404: 존재하지 않는 URI 또는 데이터<br>405: 허용되지 않는 메서드<br>500: 서버 에러<br><br><strong>모든 에러 응답 예시:</strong><br>{<br>&nbsp;&nbsp;&quot;success&quot;: false,<br>&nbsp;&nbsp;&quot;message&quot;: &quot;에러 메시지&quot;,<br>&nbsp;&nbsp;&quot;data&quot;: null<br>}<br>===============================",
* @OA\Contact(
* email="shine1324@gmail.com"
* )
* )
*
* @OA\Server(
* url=L5_SWAGGER_CONST_HOST,
* description=L5_SWAGGER_CONST_NAME
* )
*
* @OA\SecurityScheme(
* securityScheme="ApiKeyAuth",
* type="apiKey",
* in="header",
* name="X-API-KEY"
* )
* @OA\SecurityScheme(
* securityScheme="BearerAuth",
* type="http",
* scheme="bearer",
* bearerFormat="JWT"
* )
*
*/
class SAMInfo {}