azdAzure API Center es un servicio que le ayuda a desarrollar y mantener un inventario estructurado de las API de su organización. Con API Center, puede realizar un seguimiento de todas sus API en una ubicación centralizada, independientemente de su tipo, etapa del ciclo de vida o ubicación de implementación. API Center permite el descubrimiento, la reutilización y la gobernanza de API, lo que potencia a los equipos de plataforma API.
El portal API Center es un sitio web que permite a los desarrolladores y partes interesadas descubrir e interactuar sin problemas con las API. Nuestra implementación de referencia del portal API Center permite a los equipos de la plataforma API brindar una experiencia de descubrimiento y consumo de API basada en la web a los consumidores de API.
La implementación de referencia del portal API Center proporciona:
Para las instancias gratuitas del Centro API de SKU, se mostrará un máximo de 5 API en el portal del Centro API, independientemente de cuántas API haya en el Centro API.
Para SKU estándar, no hay límite y se mostrarán todas las API.
Antes de comenzar, asegúrese de haber cumplido con los siguientes requisitos:
Tiene dos opciones para implementar este portal del Centro API autohospedado:
azd ) para la implementación en un solo paso de la aplicación del portal. Se recomienda esta opción para un proceso de implementación optimizado.azdNOTA : Necesitará los requisitos previos adicionales para esta opción
- ✅ CLI para desarrolladores de Azure (
azd)- ✅ CLI de Azure
- ✅ CLI de GitHub
Bifurca este repositorio en tu cuenta de GitHub y clónalo.
git clone https://github.com/ < YOUR_GITHUB_ALIAS > /APICenter-Portal-Starter.git Inicie sesión con el siguiente comando. Luego, podrá utilizar azd cli para aprovisionar e implementar rápidamente la aplicación.
# Authenticate with Azure Developer CLI
azd auth login
# Authenticate with Azure CLI
az login Ejecute azd up para aprovisionar todos los recursos en Azure e implementar el código en esos recursos.
azd up Ingrese un nombre de entorno y seleccione la subscription y location que desee. Luego, se le pedirá que ingrese algunos valores más:
apiCenterExisted ).apiCenterName , apiCenterRegion y apiCenterResourceGroupName , si elige utilizar el recurso del centro API existente (valor apiCenterExisted en true ).apiCenterExisted es false ).staticAppLocation para la instancia de Azure Static Web Apps. Espere un momento a que se complete la implementación de recursos.Hay dos escenarios:
- Portal con nuevo Centro API: debe ingresar
FalseaapiCenterExistedy dejarapiCenterName,apiCenterRegionyapiCenterResourceGroupNameen blanco.- Portal con un Centro API existente: debe dar
TrueaapiCenterExistedy pasar valores aapiCenterName,apiCenterRegionyapiCenterResourceGroupName.
Si desea integrar la canalización de CI/CD con GitHub Actions, puede usar el siguiente comando para crear un repositorio de GitHub y enviar el código al repositorio. Primero que nada, inicia sesión en GitHub.
# Authenticate with GitHub CLI
gh auth loginEjecute los siguientes comandos para actualizar las variables de su repositorio de GitHub.
NOTA : asegúrese de haber bifurcado este repositorio en su cuenta de GitHub antes de ejecutar los siguientes comandos.
# Bash
AZURE_CLIENT_ID= $( ./infra/scripts/get-azdvariable.sh --key AZURE_CLIENT_ID )
azd pipeline config --principal-id $AZURE_CLIENT_ID
# PowerShell
$AZURE_CLIENT_ID = $( ./infra/scripts/Get-AzdVariable.ps1 -Key AZURE_CLIENT_ID )
azd pipeline config --principal-id $AZURE_CLIENT_ID¡Ahora estás listo para comenzar! Envíe el código al repositorio de GitHub o ejecute manualmente el flujo de trabajo de GitHub Actions para implementar su portal.
De forma predeterminada, el portal muestra todas las API de su instancia del Centro API. Puede configurar su instancia de portal para filtrar ciertas API configurando la propiedad scopingFilter en el archivo public/config.example usando la sintaxis de consulta OData. Por ejemplo:
{
"dataApiHostName": ".data..azure-apicenter.ms/workspaces/default",
"title": "API portal",
"authentication": {
"clientId": "",
"tenantId": "",
"scopes": ["https://azure-apicenter.net/user_impersonation"],
"authority": "https://login.microsoftonline.com/"
},
"scopingFilter": "customProperties/compliant eq true"
}
Para obtener una lista completa de propiedades filtrables, consulte el modelo de recursos de API del plano de datos.
NOTA : Necesitará los requisitos previos adicionales para esta opción
- ✅ Registro de aplicaciones configurado en su inquilino de Microsoft Entra ID con el alcance de permiso de API y URI de redireccionamiento correctos.
- ✅ Inicio de sesión en el portal habilitado con la asignación de roles correcta
Siga estos pasos para configurar su entorno de desarrollo:
Clonar el repositorio
git clone https://github.com/Azure/APICenter-Portal-Starter.gitCambiar a la rama principal:
git checkout main Copie o cambie el nombre del archivo public/config.example a public/config.json .
Configure el archivo public/config.json para que apunte a su servicio Azure API Center. Aquí hay una configuración de ejemplo:
{
"dataApiHostName" : " .data..azure-apicenter.ms/workspaces/default " ,
"title" : " API portal " ,
"authentication" : {
"clientId" : " " ,
"tenantId" : " " ,
"scopes" : [ " https://azure-apicenter.net/user_impersonation " ],
"authority" : " https://login.microsoftonline.com/ "
}
}Instale los paquetes necesarios.
npm installInicie el servidor de desarrollo: este comando iniciará el portal en modo de desarrollo ejecutándose localmente:
npm startAzure Static Web Apps es un servicio que crea e implementa automáticamente aplicaciones web de pila completa en Azure desde un repositorio de código. Este tutorial utiliza GitHub Actions para implementar en Azure Static Web Apps.
Para ver el portal del Centro API ejecutándose en aplicaciones web estáticas, haga clic en Ver aplicación en el explorador en la pestaña Descripción general del recurso de la aplicación web estática que creó en Azure Portal.
Consulte las pautas de contribución para obtener ideas y orientación sobre cómo mejorar la plantilla. ¡Gracias!
☀️ ¡Nos encanta saber de usted! ☀️
Sus comentarios son invaluables para nosotros y lo alentamos a compartir sus pensamientos y sugerencias en la sección de Problemas del repositorio. También puede informar errores o enviar solicitudes de funciones allí. Tenga la seguridad de que estaremos atentos a sus comentarios para mejorar continuamente. Si bien nos dedicamos a monitorear estos problemas, tenga en cuenta que este canal no forma parte de nuestro servicio de soporte técnico de Microsoft Azure.
La asistencia de soporte técnico de Microsoft Azure se limita a la configuración inicial de la aplicación de funciones de Azure que ejecuta el motor linting. Se proporciona soporte de mejor esfuerzo para problemas causados por factores ambientales, tales como (pero no limitados a): plataforma de alojamiento, entorno de desarrollo, configuración de red.
Si necesita asistencia técnica para ampliar el motor linting o mejorar las reglas existentes, aproveche las comunidades técnicas existentes, como Stack Overflow. No brindamos soporte a través de problemas de GitHub.
Damos la bienvenida y apreciamos las contribuciones de la comunidad.
Este proyecto ha adoptado el Código de conducta de código abierto de Microsoft. Para obtener más información, consulte las preguntas frecuentes sobre el Código de conducta o comuníquese con [email protected] si tiene alguna pregunta o comentario adicional.
Marcas comerciales Este proyecto puede contener marcas comerciales o logotipos de proyectos, productos o servicios. El uso autorizado de las marcas comerciales o logotipos de Microsoft está sujeto y debe seguir las Pautas de marcas y marcas comerciales de Microsoft. El uso de marcas comerciales o logotipos de Microsoft en versiones modificadas de este proyecto no debe causar confusión ni implicar patrocinio de Microsoft. Cualquier uso de marcas comerciales o logotipos de terceros está sujeto a las políticas de dichos terceros.
Recopilación de datos. El software puede recopilar información sobre usted y su uso del software y enviarla a Microsoft. Microsoft puede utilizar esta información para proporcionar servicios y mejorar nuestros productos y servicios. Puede desactivar la telemetría como se describe en el repositorio. También hay algunas características en el software que pueden permitirle a usted y a Microsoft recopilar datos de los usuarios de sus aplicaciones. Si utiliza estas funciones, debe cumplir con la ley aplicable, incluido proporcionar avisos apropiados a los usuarios de sus aplicaciones junto con una copia de la declaración de privacidad de Microsoft. Nuestra declaración de privacidad se encuentra en https://go.microsoft.com/fwlink/?LinkID=824704. Puede obtener más información sobre la recopilación y el uso de datos en la documentación de ayuda y en nuestra declaración de privacidad. Su uso del software opera como su consentimiento a estas prácticas.
MIT
