Как аннотации работают в NelmioApiDocBundle
В моем проекте Symfony я следовал документации NelmioApiDocBundle, чтобы документировать свой API. Я могу получить доступ к своим конечным точкам по адресу http://localhost/api/doc и добавил пользовательскую конечную точку для проверки http://localhost/healthcheck, которая возвращает ответ Json 200. Моя проблема в том, что когда я пытаюсь добавить аннотации и информацию о конечной точке, это не работает. В документации ничего не отображается, я что-то пропустил?
Вот мой nelmio_api_doc.yaml
documentation:
info:
title: My App
description: This is an awesome app!
version: 1.0.0
areas: # to filter documented areas
path_patterns:
- ^/api(?!/doc$) # Accepts routes under /api except /api/doc
- ^/healthcheck # Accepts routes under /api except /api/doc
Вот мой контроллер
<?php
namespace App\Controller;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Annotation\Route;
use Nelmio\ApiDocBundle\Annotation\Model;
use Nelmio\ApiDocBundle\Annotation\Security;
use OpenApi\Annotations as OA;
class HealthcheckController extends AbstractController
{
#[Route('/healthcheck', name: 'healthcheck', methods: 'GET')]
/**
*
* @OA\Get(
* path = "/healthcheck",
* summary = "Check the health of the application",
* description = "This endpoint is used to check the health of the application.",
* @OA\Response(
* response=200,
* description = "Returns OK if the application is healthy",
* @OA\JsonContent(
* type = "object",
* @OA\Property(property = "result", type = "string", example = "OK")
* )
* ),
* security = {}
* )
*
*/
public function index(): JsonResponse
{
return new JsonResponse(["result" => "OK"], 200);
}
}
Стоит ли изучать PHP в 2026-2027 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Symfony Station Communiqué - 7 июля 2023 г
Это коммюнике первоначально появилось на Symfony Station .
Symfony Station Communiqué - 17 февраля 2023 г
Это коммюнике первоначально появилось на Symfony Station , вашем источнике передовых новостей Symfony, PHP и кибербезопасности.
Управление ответами api для исключений на Symfony с помощью KernelEvents
Много раз при создании api нам нужно возвращать клиентам разные ответы в зависимости от возникшего исключения.
1
1
368
1
Перейти к ответу
Данный вопрос помечен как решенный
Ответы 1
Ответ принят как подходящий
Это мой код для контроллера работоспособности приложения Symfony 6. И да, правильное определение атрибутов утомительно, пока вы не попрактикуетесь:
<?php
declare(strict_types=1);
namespace App\Controller;
use App\Api\Dto\InfoDto;
use Nelmio\ApiDocBundle\Annotation\Model;
use OpenApi\Attributes as OA;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
class HealthController extends AbstractController
{
#[
OA\Get(
operationId: 'Readiness',
description: 'Readiness',
summary: 'checks readiness of application',
tags: ['health readiness'],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: new Model(type: InfoDto::class), type: 'object')
),
new OA\Response(response: 500, description: 'Internal Server Error'),
]
),
Route(path: '/health/readiness', name: 'readiness', methods: ['GET'])
]
public function readiness(): JsonResponse
{
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
}
#[
OA\Get(
operationId: 'health',
description: 'health',
summary: 'checks health of application',
tags: ['health'],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: new Model(type: InfoDto::class), type: 'object')
),
new OA\Response(response: 500, description: 'Internal Server Error'),
]
),
Route(path: '/health', name: 'health', methods: ['GET'])
]
public function health(): JsonResponse
{
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
}
}
Другие вопросы по теме
400 Ошибка проверки, когда я пытаюсь опубликовать сообщение с swaggerм
Параметр FastEndpoints не создан в Swagger
Spring boot 3 open api - поле массива в классе ответа не отображается
Наличие общих определений типов swagger (openapi) наряду с определениями protobuf
ASP.NET Core Minimal API POST глагол необработанное тело swagger пустые параметры
OpenAPI 3.0 – как объединить/развернуть элементы из одного массива в другой?
Можно ли в OpenAPI указывать один и тот же метод аутентификации несколько раз?
Хотите написать метод FileUpload в WebAPI с использованием NSwag?
Токен на предъявителя работает на Swagger, но не работает на почтальоне после входа в систему на почтальоне
Swagger не авторизуется в Azure при обслуживании от root, "/", хотя работает по пути, "/swagger", "/boink" и т. д
Похожие вопросы
Как внедрить коллекцию объектов с помощью доктрины, используя атрибут #[Embedded]?
Symfony Phpunit продолжает использовать реальный класс вместо макета
Как отключить графический интерфейс при запуске Symfony Panther с помощью createSeleniumClient?
Symfony предотвращает работу объекта с помощью прослушивателей
Несуществующий сервис после обновления
Отображение информации с помощью CRUD-контроллера (EasyAdmin 4 + Symfony 7)
API-пагинация и поиск с помощью Symfony и React: лучшая практика
Symfony 7 MapRequestPayload Valdation с частным конструктором
Как обновить сообщение о недействительном токене CSRF в Symfony 7
Symfony HttpClient и простой HTML DOM?
Кажется, это произошло между 23 декабря и сейчас. Моя предыдущая документация также сломалась, как и вы, когда я обновил ее до последней версии документа Nelmio. Предыдущая версия, которую я использовал, — 4.12.