Referencia e instalación de comandos de la herramienta OpenAPI de .NET
Microsoft.dotnet-openapi es una herramienta global de .NET Core para administrar las referencias de OpenAPI dentro de un proyecto.
Instalación
Para instalar Microsoft.dotnet-openapi
, ejecute el siguiente comando:
dotnet tool install -g Microsoft.dotnet-openapi
Nota
De manera predeterminada, la arquitectura de los binarios .NET que se van a instalar representa la arquitectura del sistema operativo que se está ejecutando en ese momento. Para especificar una arquitectura de SO diferente, consulte dotnet tool install, --arch option. Para más información, consulte la incidencia de GitHub dotnet/AspNetCore.Docs #29262.
Sumar
Al agregar una referencia de OpenAPI mediante cualquiera de los comandos de esta página, se agrega un elemento <OpenApiReference />
similar al siguiente al archivo .csproj
:
<OpenApiReference Include="openapi.json" />
La referencia anterior es necesaria para que la aplicación llame al código de cliente generado.
Agregar archivo
Opciones
Opción corta | Opción larga | Descripción | Ejemplo |
---|---|---|---|
-p | --updateProject | El proyecto sobre el que actuar. | dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json |
-c | --code-generator | El generador de código que se va a aplicar a la referencia. Las opciones son NSwagCSharp y NSwagTypeScript . Si no se especifica --code-generator , la herramienta usa NSwagCSharp de forma predeterminada. |
dotnet openapi add file .\OpenApi.json --code-generator |
-H | --help | Mostrar información de ayuda. | dotnet openapi add file --help |
Argumentos
Argument | Descripción | Ejemplo |
---|---|---|
source-file | El origen a partir del cual se va a crear una referencia. Debe ser un archivo de OpenAPI. | dotnet openapi add file .\OpenAPI.json |
Agregar dirección URL
Opciones
Opción corta | Opción larga | Descripción | Ejemplo |
---|---|---|---|
-p | --updateProject | El proyecto sobre el que actuar. | dotnet openapi add url --updateProject .\Ref.csproj https://contoso.com/openapi.json |
-o | --output-file | Dónde colocar la copia local del archivo OpenAPI. | dotnet openapi add url https://contoso.com/openapi.json --output-file myclient.json |
-c | --code-generator | El generador de código que se va a aplicar a la referencia. Las opciones son NSwagCSharp y NSwagTypeScript . |
dotnet openapi add url https://contoso.com/openapi.json --code-generator |
-H | --help | Mostrar información de ayuda. | dotnet openapi add url --help |
Argumentos
Argument | Descripción | Ejemplo |
---|---|---|
source-URL | El origen a partir del cual se va a crear una referencia. Debe ser una dirección URL. | dotnet openapi add url https://contoso.com/openapi.json |
Quitar
Quita la referencia de OpenAPI que coincide con el nombre de archivo dado del archivo .csproj
. Cuando la referencia de OpenAPI se quita, no se generarán los clientes. Se eliminan los archivos locales .json
y .yaml
.
Opciones
Opción corta | Opción larga | Descripción | Ejemplo |
---|---|---|---|
-p | --updateProject | El proyecto sobre el que actuar. | dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json |
-H | --help | Mostrar información de ayuda. | dotnet openapi remove --help |
Argumentos
Argument | Descripción | Ejemplo |
---|---|---|
source-file | Origen al que se va a quitar la referencia. | dotnet openapi remove .\OpenAPI.json |
Refresh
Actualiza la versión local de un archivo que se descargó usando el contenido más reciente de la dirección URL de descarga.
Opciones
Opción corta | Opción larga | Descripción | Ejemplo |
---|---|---|---|
-p | --updateProject | El proyecto sobre el que actuar. | dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json |
-h | --help | Mostrar información de ayuda. | dotnet openapi refresh --help |
Argumentos
Argument | Descripción | Ejemplo |
---|---|---|
source-URL | Dirección URL desde la que se va a actualizar la referencia. | dotnet openapi refresh https://contoso.com/openapi.json |
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de