Importación y publicación de la primera APIImport and publish your first API

En este tutorial se explica cómo importar una API de back-end de Especificación OpenAPI que reside en https://conferenceapi.azurewebsites.net?format=json.This tutorial shows how to import an "OpenAPI specification" backend API residing at https://conferenceapi.azurewebsites.net?format=json. Esta API de back-end la proporciona Microsoft y se hospeda en Azure.This backend API is provided by Microsoft and hosted on Azure.

Una vez que la API de back-end se importa en Management API (APIM), la API de APIM se convierte en una fachada de la API de back-end.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. En el momento en que se importa la API de back-end, el origen de la API y la API de APIM son idénticos.At the time you import the backend API, both the source API and the APIM API are identical. APIM permite personalizar la fachada según sus necesidades sin tocar la API de back-end.APIM enables you to customize the facade according to your needs without touching the backend API. Para obtener más información, consulte Transformación y protección de una API.For more information, see Transform and protect your API.

En este tutorial, aprenderá a:In this tutorial, you learn how to:

  • Importación de la primera APIImport your first API
  • Prueba de la API en Azure PortalTest the API in the Azure portal
  • Pruebe la API en el Portal para desarrolladoresTest the API in the Developer portal

Nueva API

Requisitos previosPrerequisites

Vaya a la instancia de API Management.Go to your API Management instance

Vaya a la instancia de API Management

  1. Inicie sesión en el Azure Portal.Sign in to the Azure portal.

  2. Seleccione Todos los servicios.Select All services.

  3. En el cuadro de búsqueda, escriba api management.In the search box, enter api management.

  4. En los resultados de búsqueda, seleccione Servicios API Management.In the search results, select API Management services.

  5. Seleccione su instancia de servicio API Management.Select your API Management service instance.

Sugerencia

Para agregar API Management a los favoritos en Azure Portal, seleccione la estrella.To add API Management to your favorites in the Azure portal, select the star.

El icono de API Management (The API Management icon (Icono de API Management) aparece ahora en el menú izquierdo del portal.) now appears in the left menu in the portal.

Importación y publicación de una API de back-end Import and publish a backend API

Esta sección explica cómo importar y publicar una API de back-end de Especificación OpenAPI.This section shows how to import and publish an OpenAPI specification backend API.

  1. Seleccione API en API MANAGEMENT.Select APIs from under API MANAGEMENT.

  2. Seleccione Especificación OpenAPI en la lista y haga clic en Completa en el elemento emergente.Select OpenAPI specification from the list and click Full in the pop-up.

    Creación de una API

    Puede establecer los valores de API durante la creación o luego accediendo a la pestaña Configuración. El asterisco rojo junto a un campo indica que el campo es obligatorio.You can set the API values during creation or later by going to the Settings tab. The red star next to a field indicates that the field is required.

    Utilice los valores de la tabla siguiente para crear su primera API.Use the values from the table below to create your first API.

    ConfiguraciónSetting ValorValue DESCRIPCIÓNDescription
    Especificación OpenAPIOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json Hace referencia al servicio que implementa la API.References the service implementing the API. API Management envía las solicitudes a esta dirección.API management forwards requests to this address.
    Nombre para mostrarDisplay name API de conferencia de demostración (API de conferencia de demostración)Demo Conference API Si presiona la tecla Tab después de escribir la dirección URL del servicio, APIM rellenará este campo en función de lo que aparece en el JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    El nombre se muestra en el Portal para desarrolladores.This name is displayed in the Developer portal.
    NombreName demo-conference-apidemo-conference-api Proporciona un nombre único para la API.Provides a unique name for the API.
    Si presiona la tecla Tab después de escribir la dirección URL del servicio, APIM rellenará este campo en función de lo que aparece en el JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    DescripciónDescription Proporcione una descripción opcional de la API.Provide an optional description of the API. Si presiona la tecla Tab después de escribir la dirección URL del servicio, APIM rellenará este campo en función de lo que aparece en el JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Esquema URLURL scheme HTTPSHTTPS Determina los protocolos que se pueden usar para acceder a la API.Determines which protocols can be used to access the API.
    Sufijo de dirección URL de APIAPI URL suffix conferenceconference El sufijo se anexa a la dirección URL base del servicio API Management.The suffix is appended to the base URL for the API management service. API Management distingue las API por su sufijo, por lo que el sufijo debe ser único para cada API de un publicador determinado.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ProductosProducts Sin límiteUnlimited Los productos son asociaciones de una o varias API.Products are associations of one or more APIs. Puede incluir varias API en un producto y ofrecerlas a los desarrolladores mediante el portal para desarrolladores.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    Para publicar la API, hay que asociarla a un producto (en este ejemplo, Unlimited).You publish the API by associating the API with a product (in this example, Unlimited). Para agregar esta nueva API a un producto, escriba el nombre del producto (también puede hacerlo más tarde desde la página de configuración).To add this new API to a product, type the product name (you can also do it later from the Settings page). Este paso se puede repetir varias veces para agregar la API a varios productos.This step can be repeated multiple times to add the API to multiple products.
    Para acceder a la API, los desarrolladores primero deben suscribirse a un producto.To get access to the API, developers must first subscribe to a product. Al suscribirse, obtienen una clave de suscripción que funciona con cualquier API de ese producto.When they subscribe, they get a subscription key that is good for any API in that product.
    Si creó la instancia de APIM, ya es un administrador, así que está suscrito a todos los productos.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    De forma predeterminada, cada instancia de API Management incluye dos productos de ejemplo: Starter y Unlimited.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    EtiquetasTags Etiquetas para organizar las API.Tags for organizing APIs. Pueden usarse etiquetas para buscar, agrupar o filtrar.Tags can be used for searching, grouping, or filtering.
    ¿Definir versión de esta API?Version this API? Para más información sobre las versiones, consulte Publicación de varias versiones de la API.For more information about versioning, see Publish multiple versions of your API

    Nota

    Para publicar la API, debe asociarla a un producto.To publish the API, you must associate it with a product. Puede hacerlo desde la página de configuración.You can do it from the Settings page.

  3. Seleccione Crear.Select Create.

Sugerencia

Si surgen problemas con la importación de su propia definición de API, consulte la lista de problemas y restricciones conocidos.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

Prueba de la nueva API APIM en Azure PortalTest the new APIM API in the Azure portal

Prueba del mapa de API

Se puede llamar a las operaciones directamente desde Azure Portal, lo que proporciona una forma cómoda de ver y probar las operaciones de una API.Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.

  1. Seleccione la API que ha creado en los pasos anteriores (desde la pestaña API).Select the API you created in the previous step (from the APIs tab).

  2. Presione la pestaña Prueba.Press the Test tab.

  3. Haga clic en GetSpeakers.Click on GetSpeakers. En la página se muestran los campos de los parámetros de consulta, que, en este caso, no tiene ninguno, y los encabezados.The page displays fields for query parameters, in this case none, and headers. Uno de los encabezados es "Ocp-Apim-Suscripción-Key", para la clave de suscripción del producto que está asociado a esta API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. La clave se rellena automáticamente.The key is filled in automatically.

  4. Presione Enviar.Press Send.

    Back-end responde con 200 Aceptar y algunos datos.Backend responds with 200 OK and some data.

Llamada a una operación desde el portal para desarrolladores Call an operation from the developer portal

También se pueden llamar a las operaciones desde el portal para desarrolladores para probar las API.Operations can also be called from the Developer portal to test APIs.

  1. Desplácese hasta el portal para desarrolladores.Navigate to the Developer portal.

    Portal para desarrolladores

  2. Seleccione API, haga clic en Demo Conference API y, después, en GetSpeakers.Select APIS, click on Demo Conference API and then GetSpeakers.

    En la página se muestran los campos de los parámetros de consulta, que, en este caso, no tiene ninguno, y los encabezados.The page displays fields for query parameters, in this case none, and headers. Uno de los encabezados es "Ocp-Apim-Suscripción-Key", para la clave de suscripción del producto que está asociado a esta API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Si ha creado la instancia APIM, ya es administrador, por lo que la clave se rellena automáticamente.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Presione Try it (Probarlo).Press Try it.

  4. Presione Enviar.Press Send.

    Después de invocar una operación, el portal para desarrolladores muestra las respuestas.After an operation is invoked, the developer portal shows the responses.

Pasos siguientes Next steps

En este tutorial aprendió lo siguiente:In this tutorial, you learned how to:

  • Importación de la primera APIImport your first API
  • Prueba de la API en Azure PortalTest the API in the Azure portal
  • Pruebe la API en el Portal para desarrolladoresTest the API in the Developer portal

Avance hasta el siguiente tutorial:Advance to the next tutorial: