Configuración de la referencia de API

Herramientas de IA

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 aparecerán a la derecha.

Allow Download

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

Show Try It Out

Habilita el API Playground para probar las API directamente desde la referencia de API.

Show Content-Type Header

Para las operaciones (solo OAS3) que tienen cuerpo de solicitud, al marcar esta opción se muestra en el ejemplo un encabezado que define el content-type. 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 marcar esta opción 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á desmarcada de forma predeterminada, lo que apila todos los endpoints en una sola página. Cuando está marcada, los lectores ven un endpoint a la vez. La referencia de API se abre con una vista general de 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 completo.

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, "Allow Tags to Expand" no tiene efecto, ya que solo hay un endpoint en pantalla.

Allow Tags to Expand

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

Cuando se permite que las etiquetas se expandan, se muestra la etiqueta con su descripción, junto con una tabla de todas las operaciones disponibles bajo esa etiqueta. Además, aparecerá un botón para "Show" las operaciones.

Anything missing? Leave us feedback