Configuración de la referencia de API

Además de la generación de código, cada referencia de API tiene ajustes que puedes administrar. Para abrirlos, abre Manage Sections y selecciona la referencia de API en la lista de la izquierda; sus ajustes aparecen a la derecha como interruptores. La mayoría están en la tarjeta Display; los interruptores del playground y de OAuth2 están en la tarjeta API Playground. Los cambios se guardan en cuanto activas o desactivas un interruptor.


Allow Download

El interruptor Allow download permite que la referencia de API se pueda descargar mostrando un botón en la parte superior de la página.

Show API Playground

El interruptor Show API Playground, en la tarjeta API Playground, habilita el API Playground para probar las API directamente desde la referencia de API. El interruptor OAuth2 authentication que está junto a él añade autenticación OAuth 2.0 al playground.

Show Content-Type Header

Para las operaciones (solo OAS3) que tienen cuerpo de solicitud, al activar Show Content-Type header se muestra en el ejemplo un encabezado que define el tipo de contenido. Por ejemplo:

curl --request POST \
--url https://api.developerhub.io/api/v1/version/{versionId}/reference \
--header "Content-Type: application/json" # <--- This line would be added
--form "file=@{file}"

Show Accept Header

Para las operaciones (solo OAS3), al activar Show Accept header se muestra en el ejemplo un encabezado que define el tipo de medio de respuesta aceptado. Por ejemplo:

curl --request GET \
--url https://api.developerhub.io/api/v1/page?version_id={version_id}&version_slug={version_slug}&documentation_id={documentation_id}&documentation_slug={documentation_slug}&page_slug={page_slug}&format={format} \
--header "Accept: application/json"

One Endpoint Per Page

Está activado de forma predeterminada en una nueva referencia de API. Cuando One endpoint per page está activado, los lectores ven un endpoint a la vez. La referencia de API se abre en una vista general con su título, descripción, servidores y autenticación, seguida de cada etiqueta con su descripción y enlaces a los endpoints que contiene. Al elegir un endpoint, ya sea desde el índice o desde la vista general, este ocupa la página por sí solo.

Desactívalo para apilar todos los endpoints en una sola página. Una referencia de API existente conserva el diseño que ya tiene.

Las URL no cambian, por lo que los enlaces profundos existentes, los resultados de búsqueda y cualquier enlace que hayas compartido siguen llevando al mismo endpoint.

Mientras esta opción está activada, Expandable (Allow Tags to Expand) no tiene efecto, ya que solo hay un endpoint en pantalla a la vez.

Allow Tags to Expand

Si tu referencia de API es extensa, cargar miles de elementos podría ser lento. Para optimizar el rendimiento, puedes activar el interruptor Expandable para permitir que las etiquetas se expandan. Al permitirlo, puedes cargar una referencia de API de cualquier tamaño sin afectar el rendimiento.

Cuando se permite que las etiquetas se expandan, solo se abre la primera. Todas las demás muestran su descripción junto con una tabla de las operaciones disponibles en ella y un botón Show para expandir sus operaciones.


Allow Index to Collapse

Cuando Index collapsible está activado, las etiquetas del índice se pueden contraer.

Auto-Capitalize Tags

Cuando Auto-capitalize tags está activado (valor predeterminado), las etiquetas se escriben automáticamente con mayúscula inicial en cada palabra.

Show Request Example Code Samples

Show request code samples está activado de forma predeterminada. Cuando está desactivado, solo se muestra una URL de ejemplo o un cuerpo de solicitud, en lugar de permitir que el lector elija una biblioteca de código para ver un ejemplo.

  Última actualización