Importare e pubblicare la prima APIImport and publish your first API

Questa esercitazione illustra come importare un'API back-end "Specifica OpenAPI" che risiede in 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. Questa API back-end è fornita da Microsoft e ospitata in Azure.This backend API is provided by Microsoft and hosted on Azure.

Dopo l'importazione dell'API back-end in Gestione API, l'API di Gestione API diventa una facciata per l'API back-end.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. Al momento dell'importazione dell'API back-end, l'API di origine e l'API di Gestione API sono identiche.At the time you import the backend API, both the source API and the APIM API are identical. Gestione API consente di personalizzare la facciata in base alle proprie esigenze senza modificare l'API back-end.APIM enables you to customize the facade according to your needs without touching the backend API. Per altre informazioni, vedere Trasformare e proteggere l'API.For more information, see Transform and protect your API.

In questa esercitazione si apprenderà come:In this tutorial, you learn how to:

  • Importare la prima APIImport your first API
  • Testare l'API nel portale di AzureTest the API in the Azure portal
  • Testare l'API nel portale per sviluppatoriTest the API in the Developer portal

Nuova API

PrerequisitiPrerequisites

Passare all'istanza di Gestione APIGo to your API Management instance

Passare all'istanza di Gestione API

  1. Accedere al portale di Azure.Sign in to the Azure portal.

  2. Selezionare Tutti i servizi.Select All services.

  3. Nella casella di ricerca immettere api management.In the search box, enter api management.

  4. Nei risultati della ricerca selezionare Servizi Gestione API.In the search results, select API Management services.

  5. Selezionare l'istanza del servizio Gestione API in esecuzione.Select your API Management service instance.

Suggerimento

Per aggiungere Gestione API ai Preferiti del portale di Azure, selezionare la stella.To add API Management to your favorites in the Azure portal, select the star.

L'icona della Gestione API (The API Management icon (icona della Gestione API) viene ora visualizzata nel menu a sinistra nel portale.) now appears in the left menu in the portal.

Importare e pubblicare un'API back-end Import and publish a backend API

Questa sezione illustra come importare e pubblicare un'API back-end Specifica OpenAPI.This section shows how to import and publish an OpenAPI specification backend API.

  1. Selezionare API in GESTIONE API.Select APIs from under API MANAGEMENT.

  2. Selezionare Specifica OpenAPI nell'elenco e fare clic su Completa nell'elemento popup.Select OpenAPI specification from the list and click Full in the pop-up.

    Creare un'API

    È possibile impostare i valori dell'API durante la creazione o successivamente andando alla scheda Impostazioni. L'asterisco rosso accanto a un campo indica che il campo è obbligatorio.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.

    Usare i valori della tabella seguente per creare la prima API.Use the values from the table below to create your first API.

    ImpostazioneSetting ValoreValue DESCRIZIONEDescription
    Specifica OpenAPIOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json Fa riferimento al servizio che implementa l'APIReferences the service implementing the API. e corrisponde all'indirizzo a cui Gestione API inoltra le richieste.API management forwards requests to this address.
    Nome visualizzatoDisplay name Demo Conference APIDemo Conference API Se si preme TAB dopo avere immesso l'URL del servizio, Gestione API compilerà questo campo in base al contenuto del file JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Questo nome viene visualizzato nel portale per sviluppatori.This name is displayed in the Developer portal.
    NomeName demo-conference-apidemo-conference-api Fornisce un nome univoco per l'API.Provides a unique name for the API.
    Se si preme TAB dopo avere immesso l'URL del servizio, Gestione API compilerà questo campo in base al contenuto del file JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    DescrizioneDescription Fornisce una descrizione facoltativa dell'API.Provide an optional description of the API. Se si preme TAB dopo avere immesso l'URL del servizio, Gestione API compilerà questo campo in base al contenuto del file JSON.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Schema URLURL scheme HTTPSHTTPS Determina i protocolli da usare per l'accesso all'API.Determines which protocols can be used to access the API.
    Suffisso dell'URL dell'APIAPI URL suffix conferenceconference Il suffisso viene aggiunto all'URL di base del servizio Gestione API.The suffix is appended to the base URL for the API management service. Gestione API distingue le API in base al suffisso, quindi è necessario che questo sia univoco per ciascuna API di un editore specifico.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ProdottiProducts IllimitatoUnlimited I prodotti sono associazioni di una o più API.Products are associations of one or more APIs. È possibile includere diverse API in un prodotto e offrirle agli sviluppatori tramite il portale per sviluppatori.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    Per pubblicare l'API, associarla a un prodotto (in questo esempio, Unlimited).You publish the API by associating the API with a product (in this example, Unlimited). Per aggiungere la nuova API a un prodotto, digitare il nome del prodotto. È possibile eseguire questa operazione anche in un secondo momento nella pagina Impostazioni.To add this new API to a product, type the product name (you can also do it later from the Settings page). Questo passaggio può essere ripetuto più volte per aggiungere l'API a più prodotti.This step can be repeated multiple times to add the API to multiple products.
    Per avere accesso all'API, gli sviluppatori devono prima sottoscrivere un prodotto.To get access to the API, developers must first subscribe to a product. In questo modo ottengono una chiave di sottoscrizione valida per tutte le API nel prodotto.When they subscribe, they get a subscription key that is good for any API in that product.
    Se si è creata l'istanza di Gestione API, si è già un amministratore ed è quindi già stata effettuata la sottoscrizione di ogni prodotto.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    Per impostazione predefinita, con ogni istanza di Gestione API vengono forniti due prodotti di esempio: Starter e Senza limiti.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    TagTags Tag per l'organizzazione delle API.Tags for organizing APIs. I tag possono essere usati per le operazioni di ricerca, raggruppamento o filtro.Tags can be used for searching, grouping, or filtering.
    Assegnare un numero di versione a questa API?Version this API? Per altre informazioni sul controllo delle versioni, vedere Pubblicare più versioni dell'API.For more information about versioning, see Publish multiple versions of your API

    Nota

    Per pubblicare l'API, è necessario associarla a un prodotto.To publish the API, you must associate it with a product. È possibile eseguire questa operazione nella pagina Impostazioni.You can do it from the Settings page.

  3. Selezionare Create (Crea).Select Create.

Suggerimento

In caso di problemi nell'importazione della definizione API, vedere l'elenco delle restrizioni e dei problemi noti.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

Testare la nuova API di Gestione API nel portale di AzureTest the new APIM API in the Azure portal

Mappa di test API

È possibile chiamare le operazioni direttamente dal portale di Azure, che consente di visualizzare e testare le operazioni di un'API in tutta comodità.Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.

  1. Selezionare l'API creata nel passaggio precedente nella scheda API.Select the API you created in the previous step (from the APIs tab).

  2. Fare clic sulla scheda Test.Press the Test tab.

  3. Fare clic su GetSpeakers.Click on GetSpeakers. La pagina visualizza i campi per i parametri di query, che in questo caso non esistono, e le intestazioni.The page displays fields for query parameters, in this case none, and headers. Una delle intestazioni è "Ocp-Apim-Subscription-Key", per la chiave di sottoscrizione del prodotto associato all'API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. La chiave viene compilata automaticamente.The key is filled in automatically.

  4. Fare clic su Invia.Press Send.

    Il back-end risponde con 200 OK e alcuni dati.Backend responds with 200 OK and some data.

Chiamare un'operazione dal portale per sviluppatori Call an operation from the developer portal

È anche possibile chiamare le operazioni dal portale per sviluppatori per testare le API.Operations can also be called from the Developer portal to test APIs.

  1. Passare al portale per sviluppatori.Navigate to the Developer portal.

    Portale per sviluppatori

  2. Selezionare API, fare clic su Demo Conference API (API Demo Conference) e quindi su GetSpeakers.Select APIS, click on Demo Conference API and then GetSpeakers.

    La pagina visualizza i campi per i parametri di query, che in questo caso non esistono, e le intestazioni.The page displays fields for query parameters, in this case none, and headers. Una delle intestazioni è "Ocp-Apim-Subscription-Key", per la chiave di sottoscrizione del prodotto associato all'API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Se si è creata l'istanza di Gestione API, si è già un amministratore, quindi la chiave viene inserita automaticamente.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Fare clic su Prova.Press Try it.

  4. Fare clic su Invia.Press Send.

    Dopo la chiamata di un'operazione, nel portale per sviluppatori vengono visualizzate le risposte.After an operation is invoked, the developer portal shows the responses.

Passaggi successivi Next steps

Questa esercitazione illustra come:In this tutorial, you learned how to:

  • Importare la prima APIImport your first API
  • Testare l'API nel portale di AzureTest the API in the Azure portal
  • Testare l'API nel portale per sviluppatoriTest the API in the Developer portal

Passare all'esercitazione successiva:Advance to the next tutorial: