Swagger İçinde otomatik olarak API belgeleri oluşturmak gibi araçları kullanmak, Laravel API'niz için belgeler oluşturmanın ve sürdürmenin uygun bir yoludur. Swagger API'lerinizi tanımlamanıza, belgelemenize ve test etmenize yardımcı olan açık kaynaklı bir araçtır. API belgeleri oluşturmak için Swagger in'i şu şekilde kullanabilirsiniz: Laravel
1. Adım: Swagger İçin yükleyin Laravel
Swagger package for yüklemek için besteci kullanın Laravel. package Bu amaçla popüler bir darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
2. Adım: Yapılandırın Swagger
Yüklemeden sonra, belgeleri uygulamanızın dizininde Swagger yayınlamanız gerekir. Bunu komutları çalıştırarak yapabilirsiniz: public Laravel Artisan
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
Ardından, belgelerin yayınlanacağı konumu belirtmek de dahil olmak üzere, uygulamanız için config/l5-swagger.php yapılandırmak üzere yapılandırma dosyasını düzenlemeniz gerekir. Swagger
3. Adım: Kullanın Annotations
annotations Uygulamanızdaki Rotalarınızın belgelerini açıklamak için kullanın Laravel. Bunlar, API belgelerini otomatik olarak oluşturmak annotations için kullanılır. Swagger Örneğin:
/**
* @OA\Get(
* path="/api/users",
* operationId="getUsersList",
* tags={"Users"},
* summary="Get list of users",
* description="Returns list of users",
* @OA\Response(
* response=200,
* description="Successful operation",
* @OA\JsonContent()
* )
*)
*/
Bước 4: API'yi Gerçekleştirin Swagger
API'yi ziyaret etmek için API'yi ziyaret etmek ve URL'yi ziyaret etmek için gerçek bir API'ye ihtiyacınız var. en sevdiğim şey, en sevdiğim şeydi Swagger. Şunlar var ki, URL şu anda mevcut değil http://your-app-url/api/documentation.
Swagger Rotanızı ve rotanızı nasıl değiştireceğinize dair bir fikriniz var.
Bu, Swagger API'yi Laravel geliştirmeyi ve geliştirmeyi ve geliştirmeyi çok kolaylaştırdı.