Header Ads Widget

Ticker

6/recent/ticker-posts

Documentación De PHP Rest API Usando APIDoc

 Este tutorial ayuda a crear documentos de API REST utilizando APIDOc . El apiDoc crea una documentación usando anotaciones API de su código fuente PHP. Hay muchas aplicaciones que se ejecutan en microservicios y servicios Rest.

APIDOC es un paquete npm que creará documentación de API. Estamos usando nodejs y npm para apidoc como dependencia, estoy usando PHP Laravel API como API de origen para crear documentos API.

Las anotaciones de PHP para la documentación de API -

Debe agregar la notación anterior para cada método que desee mostrar en la vista apidocs .

  • @api {get} / employee : se utilizará para definir los puntos finales de descanso.
  • @apiVersion : Esto se utilizará para definir la versión de API.
  • @apiName : esto se usará para definir el nombre del método del controlador que manejará por punto final.
  • @apiGroup : Esto se utilizará para definir el nombre del grupo de api de descanso.
  • @apiSuccess : Esto se utilizará para definir el nombre variable de respuesta con el tipo.
  • @apiError : esto se usará para definir la respuesta de error variable con el tipo.
  • @apiParam / employee : Esto se usará para definir el parámetro para la api de descanso.
  • @apiSampleRequest : se utiliza para habilitar la función de prueba.

Instalar APIDoc Usando Npm

Vamos a instalar apiDoc globalmente usando -gla opción:

npm install apidoc -g

Proyecto Simple Para Crear Documentación De API

Creemos un proyecto de API simple para crear documentación.

Paso 1: Creó la carpeta 'apidocs' en xampp/htdocs/.
Paso 2: Defina la metainformación de apiDoc, crearemos un apidoc.jsonarchivo y agregaremos la siguiente metainformación en este archivo:

Paso 3: Creó dos carpetas en la carpeta 'apidocs' , el nombre de la carpeta es / source y el otro es / apidoc . La carpeta / source tendrá todos los .phparchivos y la carpeta / apidoc habrá generado archivos de documentación API.

Paso 4: creó un ApiController.phparchivo de muestra y lo guardó en la carpeta / source , se agregó el siguiente código en este archivo:

Puede generar documentación de API usando el siguiente comando:
apidoc -i source/ -o apidoc/

El comando anterior creará la estructura de documentos API en la apidoc/carpeta, podemos cambiar la ruta de origen según nuestras necesidades.

Ahora abra http://localhost/apidocs/doc/la ruta de ubicación en el navegador.

Cómo Habilitar La Función TryOut

También puede habilitar la función de prueba de API utilizando la anotación @apiSampleRequest .

Necesita agregar URi ( http://dummy-api/api/v1base en el apidoc.jsonarchivo.

Después de cualquier cambio en la anotación o la metainformación, debe volver a generar api docs usando command.

Publicar un comentario

0 Comentarios