1. Go to this page and download the library: Download freedomcore/laravel-openapi library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
freedomcore / laravel-openapi example snippets
/**
* Class User
* @package App\Http\Controllers\User
*/
#[FreedomCore\OpenAPI\Attributes\Controller(
name: 'User',
description: 'User related endpoints'
)]
class User extends Controller {
}
/**
* Post constructor.
* @param string $description
* @param bool $deprecated
*/
public function __construct(string $description = '', bool $deprecated = false) {
parent::__construct('POST', $description, $deprecated);
}
/**
* Put constructor.
* @param string $description
* @param bool $deprecated
*/
public function __construct(string $description = '', bool $deprecated = false) {
parent::__construct('PUT', $description, $deprecated);
}
namespace FreedomCore\OpenAPI\Attributes\Response;
use Attribute;
/**
* Class Response
* @package FreedomCore\OpenAPI\Attributes\Response
*/
#[Attribute(Attribute::TARGET_METHOD)]
class Response {
/**
* Response code
* @var int
*/
public int $code;
/**
* Response description
* @var string
*/
public string $description;
/**
* Response constructor.
* @param int $code
* @param string $description
*/
public function __construct(int $code, string $description) {
$this->code = $code;
$this->description = $description;
}
}
namespace FreedomCore\OpenAPI\Attributes\Response;
use Attribute;
/**
* Class Ok
* @package FreedomCore\OpenAPI\Attributes\Response
*/
#[Attribute(Attribute::TARGET_METHOD)]
class Ok extends Response {
/**
* Ok constructor.
* @param string $description
*/
public function __construct(string $description = '') {
parent::__construct(200, $description);
}
}
namespace App\Http\Controllers\User;
use App\Http\Requests\User\{
AuthenticateRequest,
CreateRequest,
EmailRequest,
UsernameRequest
};
use App\Http\Resources\User\{
DeviceCollection,
TokenCollection,
UserResource
};
use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
use FreedomCore\OpenAPI\Attributes;
use App\Http\Controllers\Controller;
use App\Contracts\Repositories\UserRepositoryContract;
use App\Contracts\Repositories\UserDeviceRepositoryContract;
/**
* Class User
* @package App\Http\Controllers\User
*/
#[Attributes\Controller(
name: 'User',
description: 'User related endpoints'
)]
class User extends Controller {
/**
* User repository instance
* @var UserRepositoryContract
*/
private UserRepositoryContract $userRepository;
/**
* User Device repository instance
* @var UserDeviceRepositoryContract
*/
private UserDeviceRepositoryContract $userDeviceRepository;
/**
* User constructor.
* @param UserRepositoryContract $userRepository
* @param UserDeviceRepositoryContract $userDeviceRepository
*/
public function __construct(
UserRepositoryContract $userRepository,
UserDeviceRepositoryContract $userDeviceRepository
) {
$this->userRepository = $userRepository;
$this->userDeviceRepository = $userDeviceRepository;
}
/**
* E-Mail exists
* @param EmailRequest $request
* @return JsonResponse
*/
#[
Attributes\Response\Ok(
description: 'Successfully queried E-Mail existence'
),
Attributes\Request\Get(
description: 'Check whether specified E-Mail exists in the database'
)
]
public function existsEmail(EmailRequest $request): JsonResponse {
return response()->success('Successfully queried E-Mail existence', [
'exists' => $this->userRepository->emailExists($request->get('email'))
]);
}
/**
* Username exists
* @param UsernameRequest $request
* @return JsonResponse
*/
#[
Attributes\Response\Ok(
description: 'Successfully queried Username existence'
),
Attributes\Request\Get(
description: 'Check whether specified Username exists in the database'
)
]
public function existsUsername(UsernameRequest $request): JsonResponse {
return response()->success('Successfully queried Username existence', [
'exists' => $this->userRepository->usernameExists($request->get('username'))
]);
}
/**
* Create new user
* @param CreateRequest $request
* @return JsonResponse
*/
#[
Attributes\Request\Post('Create new user account using provided data'),
Attributes\Response\Ok('Successfully created new account'),
Attributes\Response\Forbidden('Invalid security code provided'),
Attributes\Response\InternalServerError('Failed to create account')
]
public function create(CreateRequest $request): JsonResponse {
return $this->userRepository->create($request);
}
/**
* Authenticate
* @param AuthenticateRequest $request
* @return JsonResponse
*/
#[
Attributes\Request\Post('Authenticate user using provided credentials'),
Attributes\Response\Ok('Successfully authenticated user using provided credentials'),
Attributes\Response\Unauthorized('Invalid credentials provided'),
Attributes\Response\InternalServerError('Failed to authenticate user due to internal server error')
]
public function login(AuthenticateRequest $request): JsonResponse {
return $this->userRepository->login($request, $this->userDeviceRepository);
}
/**
* Log Out
* @param Request $request
* @return JsonResponse
*/
#[
Attributes\Request\Post('Log Out currently authenticated user'),
Attributes\Response\Ok('Successfully logged out currently authenticated user'),
Attributes\Response\InternalServerError('Failed to log out authenticated user due to internal server error')
]
public function logout(Request $request): JsonResponse {
return $this->userRepository->logout($request);
}
/**
* Me
* @param Request $request
* @return UserResource
*/
#[
Attributes\Request\Get('Retrieve user information from request'),
Attributes\Response\Ok('Successfully fetched information for currently authenticated user'),
Attributes\Response\Forbidden('Invalid authorization token provided'),
Attributes\Response\InternalServerError('Failed to fetch information for authenticated user due to internal server error')
]
public function user(Request $request): UserResource {
return new UserResource($this->userRepository->fromRequest($request));
}
/**
* My Devices
* @param Request $request
* @return DeviceCollection
*/
#[
Attributes\Request\Get('Get list of devices associated with account'),
Attributes\Response\Ok('Successfully fetched list of devices for currently authenticated user'),
Attributes\Response\Forbidden('Invalid authorization token provided'),
Attributes\Response\InternalServerError('Failed to fetch devices list for authenticated user due to internal server error')
]
public function devices(Request $request): DeviceCollection {
return new DeviceCollection($this->userDeviceRepository->forUser($request->user()));
}
/**
* My Tokens
* @param Request $request
* @return TokenCollection
*/
#[
Attributes\Request\Get('Get list of tokens associated with account'),
Attributes\Response\Ok('Successfully fetched list of tokens for currently authenticated user'),
Attributes\Response\Forbidden('Invalid authorization token provided'),
Attributes\Response\InternalServerError('Failed to fetch tokens list for authenticated user due to internal server error')
]
public function tokens(Request $request): TokenCollection {
return new TokenCollection($this->userRepository->tokens($request));
}
}