Request Format pada Api Documentation Semart Api Skeleton

Berkat NelmioApiDoc Bundle, kita dapat dengan mudah mengetes Api kita tanpa perlu aplikasi lain seperti Postman misalnya. Hal ini karena NelmioApiDoc menyediakan fitur Sandbox yang memungkinkan kita melakukan request ke Api secara langsung. Tentu saja, fitur tersebut sangat memudahkan kita dalam mendevelop aplikasi secara cepat karena tidak hanya kita mampu mengetes aplikasi kita, sekaligus kita juga dapat memastikan dokumentasi yang terbentuk sudah sesuai.

Tentu akan jadi ironi jika kita membuat Api sekaligus dokumentasi dan Sandboxnya namun ketika hendak dicoba orang lain malah terjadi error. Akan lebih ironi lagi ketika justru memberikan format yang tepat lalu menyarankan untuk menggunakan aplikasi lain seperti Postman untuk mengetestnya, lalu gunanya Sandbox untuk apa? Untungnya, Semart Api Skeleton menggunakan tool yang sangat memudahkan yaitu Swagger PHP yang secara default digunakan oleh NelmioApiDoc untuk membuat dokumentasi secara otomatis.

Untuk membuat format request, kita dapat menggunakan @Swagger\Annotations\Parameter() pada controller kita. Sebagai contoh kita akan membuat format request sebagai berikut:

{
    "username": "string",
    "password": "string"
}

Kita dapat membuatnya sebagai berikut:

use Swagger\Annotations as SWG;
     /**
     * @SWG\Parameter(
     *     name="login",
     *     in="body",
     *     @SWG\Schema(
     *         @SWG\Property(property="username", type="string"),
     *         @SWG\Property(property="password", type="string")
     *     )
     * )
     */

Sangat simpel sekali bukan? Kamu dapat melihat kode lengkapnya pada file SecurityController

Leave a Reply