60 lines
1.6 KiB
PHP
60 lines
1.6 KiB
PHP
<?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> "success": false,<br> "message": "에러 메시지",<br> "data": 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"
|
|
* )
|
|
*
|
|
* @OA\Tag(
|
|
* name="Auth",
|
|
* description="로그인/로그아웃 및 인증 관련 API"
|
|
* )
|
|
* @OA\Tag(
|
|
* name="API Key 인증",
|
|
* description="API Key 유효성 검사"
|
|
* )
|
|
* @OA\Tag(
|
|
* name="User",
|
|
* description="사용자 자기 계정 관련 API"
|
|
* )
|
|
* @OA\Tag(
|
|
* name="Member",
|
|
* description="회원 관리 API"
|
|
* )
|
|
* @OA\Tag(
|
|
* name="Admin-Users",
|
|
* description="관리자 사용자 관리 API"
|
|
* )
|
|
* @OA\Tag(
|
|
* name="Product",
|
|
* description="제품 관련 API"
|
|
* )
|
|
*/
|
|
class SAMInfo {}
|