Definición de vías de acceso para una API

Una vía de acceso es una unidad de una API REST que puede llamar. Una vía de acceso está formada por un verbo HTTP y una vía de acceso de URL. Al configurar la Vía de acceso se define cómo se expone la API a los desarrolladores.

Acerca de esta tarea

Nota: Esta tarea está relacionada con la configuración de una definición de API de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen Icono OpenAPI Source . Para volver al formulario de diseño, pulse el icono Formulario Icono de formulario .

Procedimiento

Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0.
Si ya hay una o más vías de acceso definidas, expanda Vías de acceso.
Para crear una nueva vía de acceso, pulse el icono Añadir junto a Vías de acceso en el panel de navegación. Para editar una vía de acceso existente, pulse la vía de acceso en el panel de navegación.
Especifique la información siguiente:
- Vía de acceso: vía de acceso relativa a un punto final individual.
  La vía de acceso se adjunta a la vía de acceso base para crear el URI completo con el que acceder a las API. La vía de acceso debe empezar, pero no finalizar, con el carácter/. Un parámetro al final de la vía de acceso puede contener un calificador para que coincida con uno o más niveles de vía de acceso.
  
  Si especifica sólo el nombre del parámetro, se compara un nivel de esa vía de acceso. Si desea permitir varios niveles de la vía de acceso, puede añadir al parámetro uno de los calificadores siguientes:
  - * para indicar 0 o más apariciones
  - + para indicar 1 o más apariciones
  Los calificadores + y * sólo se pueden utilizar al final de la vía de acceso.
  
  Por ejemplo, la vía de acceso:
```
/petstore/{type}/{*category}
```
  coincide con las vías de acceso siguientes, donde sólo coincide un valor de tipo, pero todas (0 o más) las categorías coinciden:
```
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
```
- $ref (disponible al editar una vía de acceso existente): una referencia a una vía de acceso definida en otro lugar, ya sea en esta definición de OpenAPI o en un archivo externo. Una referencia permite reutilizar un conjunto de operaciones ya definidas para una vía de acceso en esta API o en un archivo que es una definición de API completa o un fragmento de OpenAPI.
  La referencia utiliza notación de puntero JSON. Por ejemplo, una referencia a una vía de acceso denominada /mypath en esta API tendría el formato siguiente:
```
#/paths/~1mypath
```
  Los caracteres ~1 se utilizan como escape del carácter /, que se utiliza literalmente en el nombre de vía de acceso en lugar de un carácter especial.
  Una referencia a una vía de acceso en un archivo externo denominado path_fragments.yaml tendría el formato siguiente:
```
file://path_fragments.yaml/paths/~1mypath
```
Si está creando una nueva vía de acceso, pulse Crear.
Los detalles de la vía de acceso se muestran para su posterior edición, tal como se describe en el paso 4.
Haga clic en Guardar cuando haya terminado.