[英]Symfony: Output example image in nelmio api docs?
我正在使用Nelmio Api Doc為我的API生成文檔。 我剛剛添加了一個新的終結點,該終結點根據id參數返回image / png文件。 我如何最好地在我的api文檔中表示此響應? 理想情況下,我希望在此端點的文檔的示例響應部分中顯示示例圖像。 但是我可以用nelmio做到嗎? 請看下面:
/**
*
* ### Example Response ###
* [
* {TELL NELIMO TO OUTPUT EXAMPLE IMAGE?}
* ]
*
* @Route("/image/{id}", name="image_get", requirements={"id": "\d+"})
* @Method("GET")
*
* @ApiDoc(
* section="image",
* description="Fetch image.",
* headers={
* {
* "name" : "api-key",
* "description"="Token the client needs to provide when making API calls.",
* "required"="true"
* }
* },
* requirements={
* {
* "name"="id",
* "dataType"="integer",
* "requirement"="\d+",
* "description"="ID of the image you wish to retrieve."
* }
* },
* parameters={},
* filters={},
* statusCodes={
* 200="Returned when successful",
* 400={
* "Returned when bad request",
* },
* 401={
* "Returned when unauthorized",
* },
* 404={
* "Returned when not found",
* }
* }
* )
*/
public function getAction($id, Request $request)
{
/** @var ImageRepository $imageRepository */
$imageRepository = $this->get('api.repository.image');
/** @var Image $image */
$image = $imageRepository->fetchById($id);
if(empty($image->getId())){
$problem = new ApiProblem("Image not found", "E_NOT_FOUND");
$problem->setDetail("A image could not be found.");
$problem->setInstance($request->getUri());
return new Response($problem->asJson(), Response::HTTP_NOT_FOUND);
}
/** @var string $file */
$file = file_get_contents(__DIR__ . '/../../../../app/Resources/img/' . $flag->getImg());
return new Response($file, 200, [
'Content-Type' => 'image/png',
'Content-Disposition' => 'inline; filename="'.$image->getImg().'"'
]);
}
在注釋中使用markdown就像![alt text](https://some_image.png)
,它將在nelmio api文檔中輸出。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.