Uploading an Image using Swagger API - laravel

Question

I am developing an api using Laravel 7 and I use Swagger for API documentation. My issue is that I want to upload images using the Swagger API but it doesn't it only displays [object File] when printing out the images, so I can't upload them to the public folder.
My store method
/**
* Store a newly created Products.
*
* #param \Illuminate\Http\Request $request
* #return \Illuminate\Http\Response
*
* #OA\Post(
* path="/api/products",
* tags={"Product"},
* #OA\Response(response="200", description="Adding a new Product."),
*
* #OA\Parameter(
* name="name[]",
* in="query",
* description="Product Name",
* required=true,
* #OA\Schema(type="array", #OA\Items(type="string")),
* ),
* #OA\Parameter(
* name="images[]",
* in="query",
* description="Product Images",
* required=true,
* #OA\Schema(type="array", #OA\Items(type="file")),
* ),
* * )
* )
*
*/
public function upload(Request $request)
{
$request->validate([
"name" => "required",
"images" => "required",
]);
$images = $request->images;
$product = Product::create([]);
if(! is_dir(public_path("/products")) ){
mkdir(public_path("/products"), 0777);
}
$id = $product->id;
$imageCollection = Collection::wrap($images);
$imageCollection->each(function($image) use ($id){
$basename = Str::random();
$original = $basename . "." . $image->getClientOriginalExtension();
$image->move(public_path("/products"), $original);
ProductMedia::create([
"product_id" => $id,
"image" => "/products/".$original,
]);
});
return Product::where("id", $product->id)->with("productMedia")->get();
}
How can I add images through Swagger API?

Answer 1

Instead param with image, try to do something like this
* #OA\RequestBody(
* required=true,
* #OA\MediaType(
* mediaType="multipart/form-data",
* #OA\Schema(
* #OA\Property(
* description="file to upload",
* property="file",
* type="file",
* ),
* required={"file"}
* )
* )
* ),
more examples here: https://github.com/zircote/swagger-php/blob/master/Examples/petstore.swagger.io/controllers/PetController.php

Answer 2

It looks like you are using the L5 Swagger Package. You may have to figure out how to add an annotation to allow multipart/form-data. Not sure how to configure that through the Package, but here is some more info from from the Swagger File Upload Documentation