Accedere e personalizzare il portale per sviluppatoriAccess and customize developer portal

Il portale per sviluppatori è un sito Web completamente personalizzabile e completamente personalizzabile con la documentazione delle API.Developer portal is an automatically generated, fully customizable website with the documentation of your APIs. Si tratta del punto in cui gli utenti dell'API possono individuare le API, informazioni su come usarle e richiedere l'accesso.It is where API consumers can discover your APIs, learn how to use them, and request access.

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

  • Accedere alla versione gestita del portale per sviluppatoriAccess the managed version of the developer portal
  • Esplorare l'interfaccia amministrativaNavigate its administrative interface
  • Personalizzare il contenutoCustomize the content
  • Pubblicare le modifichePublish the changes
  • Visualizzare il portale pubblicatoView the published portal

Per ulteriori informazioni, vedere il portale per sviluppatori nel portale per sviluppatori di gestione API di Azure.You can find more details on the developer portal in the Azure API Management developer portal overview.

Portale per sviluppatori di gestione API-modalità di amministrazione

prerequisitiPrerequisites

DisponibilitàAvailability

Importante

Questa funzionalità è disponibile nei livelli Premium, Standard, Basic e Developer di Gestione API.This feature is available in the Premium, Standard, Basic and Developer tiers of API Management.

Accedere al portale come amministratoreAccess the portal as an administrator

Attenersi alla procedura seguente per accedere alla versione gestita del portale.Follow the steps below to access the managed version of the portal.

  1. Passare all'istanza del servizio gestione API nella portale di Azure.Go to your API Management service instance in the Azure portal.
  2. Fare clic sul pulsante portale per sviluppatori nella barra di spostamento in alto.Click on the Developer portal button in the top navigation bar. Viene aperta una nuova scheda del browser con una versione amministrativa del portale.A new browser tab with an administrative version of the portal will open.

Informazioni sull'interfaccia amministrativa del portaleUnderstand the portal's administrative interface

Contenuto predefinitoDefault content

Se si accede al portale per la prima volta, verrà eseguito automaticamente il provisioning del contenuto predefinito in background.If you're accessing the portal for the first time, the default content will be automatically provisioned in the background. Il contenuto predefinito è stato progettato per mostrare le funzionalità del portale e ridurre al minimo la quantità di personalizzazioni necessarie per personalizzare il portale.Default content has been designed to showcase portal's capabilities and minimize the amount of customizations needed to personalize your portal. Per altre informazioni su ciò che è incluso nel contenuto del portale, vedere Panoramica del portale per sviluppatori di gestione API di Azure.You can learn more about what is included in the portal content in the Azure API Management developer portal overview.

Editor visivoVisual editor

È possibile personalizzare il contenuto del portale con l'editor visivo.You can customize the content of the portal with the visual editor. Le sezioni di menu a sinistra consentono di creare o modificare pagine, elementi multimediali, layout, menu, stili o impostazioni del sito Web.The menu sections on the left let you create or modify pages, media, layouts, menus, styles, or website settings. Le voci di menu nella parte inferiore consentono di passare da un viewport all'altra (ad esempio, mobile o desktop), visualizzare gli elementi del portale visibili agli utenti autenticati o anonimi oppure salvare o annullare le azioni.The menu items on the bottom let you switch between viewports (for example, mobile or desktop), view the elements of the portal visible to authenticated or anonymous users, or save or undo actions.

È possibile aggiungere righe a una pagina facendo clic su un'icona blu con un segno più.You can add rows to a page by clicking on a blue icon with a plus sign. È possibile aggiungere widget (ad esempio, testo, immagini o elenco di API) premendo un'icona grigia con un segno più.Widgets (for example, text, images, or APIs list) can be added by pressing a grey icon with a plus sign. È possibile ridisporre gli elementi in una pagina con l'interazione con trascinamento della selezione.You can rearrange items in a page with the drag-and-drop interaction.

Layout e pagineLayouts and pages

Pagine e layout

I layout definiscono la modalità di visualizzazione delle pagine.Layouts define how pages are displayed. Nel contenuto predefinito, ad esempio, sono presenti due layout: uno si applica al home page e l'altro a tutte le pagine rimanenti.For example, in the default content, there are two layouts - one applies to the home page, and the other to all remaining pages.

Un layout viene applicato a una pagina abbinando il relativo modello URL all'URL della pagina.A layout gets applied to a page by matching its URL template to the page's URL. Ad esempio, il layout con un modello di URL di /wiki/* verrà applicato a ogni pagina con /wiki/ segmento nell'URL: /wiki/getting-started, /wiki/stylese così via.For example, layout with a URL template of /wiki/* will be applied to every page with the /wiki/ segment in the URL: /wiki/getting-started, /wiki/styles, etc.

Nell'immagine precedente, il contenuto appartenente al layout è contrassegnato come blu, mentre la pagina è contrassegnata in rosso.In the image above, content belonging to the layout is marked in blue, while the page is marked in red. Le sezioni di menu sono contrassegnate rispettivamente.The menu sections are marked respectively.

Guida dello stileStyling guide

Guida dello stile

La Guida di stile è un pannello creato con le finestre di progettazione.Styling guide is a panel created with designers in mind. Consente di supervisionare e applicare lo stile a tutti gli elementi visivi nel portale.It allows for overseeing and styling all the visual elements in your portal. Lo stile è gerarchico. molti elementi ereditano le proprietà da altri elementi.The styling is hierarchical - many elements inherit properties from other elements. Gli elementi Button, ad esempio, usano i colori per il testo e lo sfondo.For example, button elements use colors for text and background. Per modificare il colore di un pulsante, è necessario modificare la variante di colore originale.To change a button's color, you need to change the original color variant.

Per modificare una variante, fare clic su di essa e selezionare l'icona a matita visualizzata sopra.To edit a variant, click on it and select the pencil icon that appears on top of it. Dopo aver apportato le modifiche nella finestra popup, chiuderla.Once you make the changes in the pop-up window, close it.

Pulsante SalvaSave button

Pulsante Salva

Ogni volta che si apportano modifiche nel portale, è necessario salvarle manualmente premendo il pulsante Salva nel menu in basso.Whenever you make a change in the portal, you need to save it manually by pressing the Save button in the menu at the bottom. Quando si salvano le modifiche, il contenuto modificato viene caricato automaticamente nel servizio gestione API.When you save your changes, the modified content is automatically uploaded to your API Management service.

Personalizzare il contenuto del portaleCustomize the portal's content

Prima di rendere disponibile il portale per i visitatori, è necessario personalizzare il contenuto generato automaticamente.Before you make your portal available to the visitors, you should personalize the automatically generated content. Le modifiche consigliate includono i layout, gli stili e il contenuto del home page.Recommended changes include the layouts, styles, and the content of the home page.

Nota

A causa di considerazioni sull'integrazione, le pagine seguenti non possono essere rimosse o spostate in un URL diverso: /404, /500, /captcha, /change-password, /config.json, /confirm/invitation, /confirm-v2/identities/basic/signup, /confirm-v2/password, /internal-status-0123456789abcdef``/publish, /signin, /signin-sso, /signup.Due to integration considerations, the following pages can't be removed or moved under a different URL: /404, /500, /captcha, /change-password, /config.json, /confirm/invitation, /confirm-v2/identities/basic/signup, /confirm-v2/password, /internal-status-0123456789abcdef, /publish, /signin, /signin-sso, /signup.

Home pageHome page

La Home page predefinita viene riempita con contenuto fittizio.The default Home page is filled with dummy content. È possibile rimuovere tutte le sezioni con il contenuto o mantenere la struttura e modificare gli elementi uno alla volta.You can either remove the whole sections with the content or keep the structure and adjust the elements one by one. Sostituire il testo e le immagini generati con il proprio e assicurarsi che i collegamenti puntino alle posizioni desiderate.Replace the generated text and images with your own and make sure the links point to desired locations.

LayoutLayouts

Sostituire il logo generato automaticamente nella barra di spostamento con la propria immagine.Replace the automatically generated logo in the navigation bar with your own image.

StiliStyling

Sebbene non sia necessario modificare alcuno stile, è possibile modificare determinati elementi.Although you don't need to adjust any styles, you may consider adjusting particular elements. Ad esempio, modificare il colore primario in modo che corrisponda al colore del marchio.For example, change the primary color to match your brand's color.

Esempio di personalizzazioneCustomization example

Nel video seguente viene illustrato come modificare il contenuto del portale, personalizzare l'aspetto del sito Web e pubblicare le modifiche.In the video below we demonstrate how to edit the content of the portal, customize the website's look, and publish the changes.

Pubblicare il portale Publish the portal

Per rendere disponibili il portale e le modifiche più recenti ai visitatori, è necessario pubblicarlo.To make your portal and its latest changes available to visitors, you need to publish it.

  1. Assicurarsi di aver salvato le modifiche facendo clic sull'icona Salva .Make sure you saved your changes by clicking on the Save icon.
  2. Fare clic su Pubblica sito Web nella sezione operazioni del menu.Click on Publish website in the Operations section of the menu. Questa operazione può richiedere qualche minuto.This operation may take a few minutes.
    portale di pubblicazione Publish portal

Nota

Il portale deve essere ripubblicato dopo le modifiche della configurazione del servizio gestione API, ad esempio l'assegnazione di un dominio personalizzato, l'aggiornamento dei provider di identità, l'impostazione della delega, la specifica delle condizioni di accesso e del prodotto e altro ancora.The portal needs to be republished after API Management service configuration changes, such as assigning a custom domain, updating the identity providers, setting delegation, specifying sign-in and product terms, and more.

Visita il portale pubblicatoVisit the published portal

Dopo aver pubblicato il portale, è possibile accedervi con lo stesso URL del pannello amministrativo, ad esempio https://contoso-api.developer.azure-api.net.After you publish the portal, you can access it at the same URL as the administrative panel, for example https://contoso-api.developer.azure-api.net. Visualizzarlo in una sessione del browser separata (modalità di esplorazione in incognito/privata) come visitatore esterno.View it in a separate browser session (incognito / private browsing mode) as an external visitor.

Passaggi successiviNext steps

Altre informazioni sul portale per sviluppatori:Learn more about the developer portal: