Archivo launchSettings.json en ASP.NET Core

El archivo launchSettings.json contiene la configuración que permite a Visual Studio o la CLI de .NET, conocer cómo se va a comportar la aplicación al momento de ejecutarse en el entorno local de desarrollo.

Sus principales características son:

• Permite probar de forma rápida y fácil, el comportamiento de una aplicación en diferentes entornos, sin afectar a otras.
• Se puede usar solamente en el ambiente local de desarrollo.
• No se implementa al momento de publicar el sitio web.
• Los valores establecidos en el mismo, invalidan a los del entorno global del sistema.
• Permite configurar varios perfiles de depuración.
• Se localiza en la carpeta Properties.

Partes del Archivo launchSettings.json

El archivo launchSettings.json esta formado por 2 grupos de objetos o definiciones:

• iisSettings: Define la configuración base del servidor web IIS, al momento de utilizar los perfiles IIS e IIS Express.
• profiles: Contiene la lista de perfiles de depuración.

iisSettings

iisExpress / iis

profiles

Define la lista de perfiles de depuración. Las propiedades básicas y que son configuradas de forma predeterminada al momento de crear el proyecto son:

• El valor de la propiedad commandName especifica el tipo de servidor web que se va a iniciar. Los valores que se configuran de forma predeterminada son:
  • IISExpress: Inicia el servidor web IIS Express.
  • IIS: No se ha iniciado ningún servidor web. Se espera que IIS esté disponible.
  • Project: Inicia el servidor web Kestrel.
• Si al momento de iniciar la aplicación ASP.NET Core no encuentra la variable de entorno ASPNETCORE_ENVIRONMENT, el valor predeterminado es Producción, lo que asegura que se usa el entorno correcto al momento de publicar el sitio en el ambiente de Producción.
• El comando project es equivalente a llamar dotnet run.

Existen tambien propiedades adicionales:

(1) El valor predeterminado de inspectUri es {wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}

Archivo launchSettings.json de Ejemplo

El archivo launchSettings.json siguiente, es un archivo básico y común que se genera de forma predeterminada al momento de crear un proyecto ASP.NET Core.

{
   "$schema": "http://json.schemastore.org/launchsettings.json",
   "iisSettings": {
      "windowsAuthentication": false,
      "anonymousAuthentication": true,
      "iisExpress": {
         "applicationUrl": "http://localhost:55697",
         "sslPort": 44318
      }
   },
   "profiles": {
      "http": {
         "commandName": "Project",
         "dotnetRunMessages": true,
         "launchBrowser": true,
         "applicationUrl": "http://localhost:5084",
         "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
         }
      },
      "https": {
         "commandName": "Project",
         "dotnetRunMessages": true,
         "launchBrowser": true,
         "applicationUrl": "https://localhost:5634;http://localhost:5084",
         "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
         }
      },
      "IIS Express": {
         "commandName": "IISExpress",
         "launchBrowser": true,
         "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
         }
      },
      "https-Production": {
         "commandName": "Project",
         "dotnetRunMessages": true,
         "launchBrowser": true,
         "applicationUrl": "https://localhost:5634;http://localhost:5084",
         "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Production",
            "ASPNETCORE_DETAILEDERRORS": "1",
            "ASPNETCORE_SHUTDOWNTIMEOUTSECONDS": "3"
         }
      }
   }
}

Hay varios puntos clave a recalcar:

• Los tres primeros perfiles: http, https e IIS Express, por lo general son los que se generan de forma predeterminada al momento de crear el proyecto. Si se eligen, ejecutarán la aplicación en ambiente de Desarrollo.
• El cuarto perfil con nombre https-Production, es personalizado y si se elige, ejecutará la aplicación en ambiente de Producción.
• Los perfiles http, https y https-Production tienen configurada la propiedad commandName en Project, que significa que el sitio se hospedará en el servidor web Kestrel.
• El perfil IIS Express tienen configurada la propiedad commandName en IISExpress, por lo tanto el sitio se hospedará en el servidor web IIS Express.
• El perfil http es usado de forma predeterminada en Visual Stucio macOS.
• El perfil https es usado de forma predeterminada en Visual Studio Windows.
• El perfil https escucha en ambos protocolos: http:// y https://
• Cada perfil puede tener diferentes variables de entorno, tal como se puede observar en el perfil personalizado https-Production.

launchSettings.json Visual Studio y la CLI de .NET

Para elegir el perfil de depuración en Visual Studio 2022, hay que dirigirse a la barra de herramientas Standard, menú desplegable a lado del botón Depurar, tal como se puede observar en la siguiente imagen:

Esta acción de Visual Studio equivale al siguiente comando de la CLI de .NET:

dotnet run --launch-profile https-Production

Si no se especifica un perfil, la CLI de .NET utilizará el primero que se encuentre en el archivo launchSettings.json.

dotnet run

Si no desea utilizar ningún perfil, se puede ignorar explícitamente mediante el parámetro --no-launch-profile.

dotnet run --no-launch-profile

Cabe recalcar que la CLI de .NET solo soporta los perfiles con tipos de comando que ejecuten el servidor web Kestrel. Por lo que ejecutar el siguiente comando:

dotnet run --launch-profile "IIS Express"

Tendrá como resultado el siguiente error:

The launch profile "IIS Express" could not be applied.
The launch profile type "IISExpress" is not supported.

De igual forma el siguiente comando:

dotnet run --launch-profile "IIS"

Tendrá como resultado el siguiente error:

The launch profile "IIS" could not be applied.
The launch profile type "IIS" is not supported.

Editar el Archivo launchSettings.json Visualmente desde Visual Studio 2022

Visual Studio permite editar el archivo launchSettings.json de forma gráfica de dos formas.

La primera:

1. Seleccionar el proyecto ASP.NET Core.
2. Presionar el clic derecho y elegir la opción Propiedades, o presionar la combinación de teclas Alt+Enter.
3. Elegir la pestaña Debug.
4. Presionar el enlace Open debug launch profiles UI.

La segunda y la más fácil de acceder es mediante el mismo menú que permite elegir los perfiles de lanzamiento o depuración, y elegir la opción <Nombre del Proyecto> Debug Properties.

La ventana de Launch Profiles o Perfiles de Lanzamiento se abrirá, y se mostrarán todos los perfiles configurados, pudiendo así editarlos.

Recursos Adicionales

• Usar varios entornos en ASP.NET Core.
• Esquema del archivo launchsettings.json.
• JSON Schema Store.
• Json.org.
• CLI de .NET.