Справочник по команде средства .NET OpenAPI и установка
Microsoft.dotnet-openapi — это глобальное средство .NET Core для управления ссылками OpenAPI в рамках проекта.
Установка
Чтобы установить Microsoft.dotnet-openapi
, выполните следующую команду:
dotnet tool install -g Microsoft.dotnet-openapi
Примечание.
По умолчанию архитектура двоичных файлов .NET для установки представляет архитектуру операционной системы. Чтобы указать другую архитектуру ОС, см . параметр dotnet tool install, --arch. Дополнительные сведения см. в статье о проблеме GitHub dotnet/AspNetCore.Docs #29262.
Добавить
Добавление ссылки OpenAPI с помощью любой из команд на этой странице добавляет <OpenApiReference />
элемент, аналогичный следующему файлу .csproj
:
<OpenApiReference Include="openapi.json" />
Для вызова созданного клиентского кода приложению требуется предыдущая ссылка.
Добавить файл
Параметры
Короткий параметр | Длинный параметр | Description | Пример |
---|---|---|---|
-p | --updateProject | Проект для выполнения операции. | dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json |
-c | --code-generator | Генератор кода, применяемый к ссылке. Возможные значения: NSwagCSharp и NSwagTypeScript . Если атрибут --code-generator не задан, по умолчанию для средств будет выбрано NSwagCSharp . |
dotnet openapi add file .\OpenApi.json --code-generator |
-h | --help | Отображает справочные сведения. | dotnet openapi add file --help |
Аргументы
Аргумент | Description | Пример |
---|---|---|
source-file | Источник, из которого создается ссылка. Должен быть файлом OpenAPI. | dotnet openapi add file .\OpenAPI.json |
Добавление URL-адреса
Параметры
Короткий параметр | Длинный параметр | Description | Пример |
---|---|---|---|
-p | --updateProject | Проект для выполнения операции. | dotnet openapi add url --updateProject .\Ref.csproj https://contoso.com/openapi.json |
o- | --output-file | Место размещения локальной копии файла OpenAPI. | dotnet openapi add url https://contoso.com/openapi.json --output-file myclient.json |
-c | --code-generator | Генератор кода, применяемый к ссылке. Возможные значения: NSwagCSharp и NSwagTypeScript . |
dotnet openapi add url https://contoso.com/openapi.json --code-generator |
-h | --help | Отображает справочные сведения. | dotnet openapi add url --help |
Аргументы
Аргумент | Description | Пример |
---|---|---|
source-URL | Источник, из которого создается ссылка. Должен быть URL-адресом. | dotnet openapi add url https://contoso.com/openapi.json |
Удалить
Удаляет ссылку OpenAPI, соответствующую заданному .csproj
имени файла из файла. При удалении ссылки OpenAPI клиенты не будут создаваться. Локальные .json
и .yaml
файлы удаляются.
Параметры
Короткий параметр | Длинный параметр | Description | Пример |
---|---|---|---|
-p | --updateProject | Проект для выполнения операции. | dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json |
-h | --help | Отображает справочные сведения. | dotnet openapi remove --help |
Аргументы
Аргумент | Description | Пример |
---|---|---|
source-file | Источник, ссылку на который необходимо удалить. | dotnet openapi remove .\OpenAPI.json |
Refresh
Обновляет локальную версию файла, скачанного с использованием последнего содержимого из URL-адреса для скачивания.
Параметры
Короткий параметр | Длинный параметр | Description | Пример |
---|---|---|---|
-p | --updateProject | Проект для выполнения операции. | dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json |
-h | --help | Отображает справочные сведения. | dotnet openapi refresh --help |
Аргументы
Аргумент | Description | Пример |
---|---|---|
source-URL | URL-адрес, ссылку из которого необходимо обновить. | dotnet openapi refresh https://contoso.com/openapi.json |
ASP.NET Core
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по