Selamlar arkadaşlar bugünkü dersimizde sizlere api ile karşı tarafa nasıl belge açıcaz onu göstericem ve bu belge üstünden herşeyi karşı taraf ve biz yöneticez hemen başlayalım;

Api'de karşı tarafa açtığımız api dosyalarımızı get,post vs... belgelendirebiliyoruz bunun için aşağıdaki örneğimize bakalım...
ilk önce şu adrese girin; https://github.com/DarkaOnLine/L5-Sw...-Configuration
ve sonra terminale; composer require "darkaonline/l5-swagger"
konposeri yükleyin... ve ondan sonra sıra ile adımları uygulayın...


örnek:

1. adım;

model dosyamızdaki class'ın üstüne şu aşağıdaki kodu yazıyoruz..

/**
     * @OA\Schema(
     * title="User",
     * description="User model"
     *)
     */

2. adım;

controller dosyamızda class'ın altına şu kodu yapıştırın;

/**
     * Display a listing of the resource.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     * @OA\GET(
     * path="/aptal",
     * tags={"aptal"},
     * summary="List all aptal",
     * @OA\Response(
     * response=200,
     * description="islem basarili"
     * )
     * )
     */

burda ne yaptık ? cevap: get parametresini açtık...

3. adım;

app klasörünün içine herhangi bir php dosyası oluşturuyoruz mesela :api-doc.php gibi....
ondan sonra
şukodu yazın;

/**
 * @OA\Info(title="My First API", version="0.1")
 */
/**
*  @OA\Info(
*   version="1.0.0",
*   title="Laravel Apim",
*   description="Aciklama budur",
*   termsOfService="http://localhost/antreman/public/api/terms",
*  @OA\Contact(email="info@yazilimdukkanim.com"),
*  @OA\License(name="pache 2.0",url="http://www.apache.org/licenses/LICENSE-2.0.html")
*)
*/

ve sonra terminale girip şu kodu terminale yazın;
php artisan l5-swagger:generate
ve ondan sonrada en son olarak aşağıdaki urlyi yani tarayıcıya yapıştırın;

http://localhost/antreman/public/api/documentation

urlyi farkettiyseniz sonu documentation olucak...

artık Api belgesi hazır...
emeğe saygı arkadaşlar bir teşekkürü çok görmeyin...