是否可以更改由NSwag生成的示例值部分的内容？
是的，可以更改由NSwag生成的示例值部分的内容。NSwag是一个用于生成OpenAPI/Swagger规范的工具，它可以根据代码和注释自动生成API文档和客户端代码。在生成的文档中，NSwag会根据代码中的数据类型和默认值生成示例值部分。
要更改示例值部分的内容，可以通过以下步骤进行操作：
- 打开NSwag生成的配置文件（通常是一个JSON或YAML文件），可以在其中找到API的定义和配置信息。
- 在API定义中找到需要更改示例值的参数或响应对象。
- 在参数或响应对象的定义中，可以找到一个名为"example"或"examples"的字段，该字段用于指定示例值。
- 修改"example"或"examples"字段的值，将其更改为你想要的示例值。示例值可以是任何符合参数或响应对象定义的合法值。
- 保存配置文件并重新生成API文档和客户端代码。
需要注意的是，NSwag生成的示例值部分是根据代码和注释自动生成的，因此在更改示例值时要确保与代码和注释的定义保持一致，以避免产生不一致的情况。
推荐的腾讯云相关产品：腾讯云API网关。腾讯云API网关是一种全托管的API管理服务，可以帮助开发者更好地管理和发布API，并提供了丰富的功能，如访问控制、流量控制、日志记录等。通过腾讯云API网关，可以方便地管理和调整API的示例值，以满足不同的业务需求。
更多关于腾讯云API网关的信息，请访问：腾讯云API网关产品介绍
相关·内容
我正在尝试构建一个安装了NSwagger的项目。下面是我的.csporj配置：
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to do
浏览 0提问于2018-03-12得票数 3
应用程序将DateTime值传递给API，其中NSwag将这些值转换为DateTimeOffset对象。自动生成的客户端必须为项目中所有对象的所有DateTime属性选择DateTimeOffset或DateTimeOffset。因此，我们在这个场景中使用了DateTimeOffset。
如果将一个DateTime传递给API，那么NSwag是否将值转换为服务器正在运行的时区？
换句话说，值是否根据API的服务器位置而变化？
浏览 19提问于2022-05-16得票数 0
回答已采纳
2回答
我设置了swagger，以便在项目启动时使用NSwag生成开放的Api规范& Swagger，它基于我的WebApi中的控制器。我想把Ui的自尊心提升到
每个端点的摘要/描述
需要端点的示例参数输入
用于POST调用的示例请求主体
一个示例访问令牌，它只能在swagger文档中使用，以方便地进行身份验证并能够尝试所有内容(有点像本例中的)。
我是NSwag新手，不知道如何将这些增强添加到代码中，比如在哪里添加它们，我需要使用什么(控制器上的注释)？XML注释？另一种方式？)我尝试过在“Swagger”中编辑规范，但是不知道这是怎么做的，因为在每个应用程序启动时都
浏览 0提问于2020-11-10得票数 4
回答已采纳
我认为这是一个NSwag或NSwagStudio问题，但我还没有足够的经验来了解我是否使用错了，或者是NSwag中是否有bug，或者我正在使用的Swagger2.0文档是否有问题。
我使用NSwagStudio 13.6.1.0为生成一个C#客户端。表示order_search_request属性query的类型是一个没有属性的空类。但是Swagger声明了query的几个子类型，其中有些确实具有属性：
"query": {
"$ref": "#/definitions/query",
"description
浏览 6提问于2020-06-27得票数 1
我正在使用Nswag生成客户端库，以使用从.NET核心应用程序创建的应用程序接口。目前，我正在使用返回IActionResult的操作，以便从return NotFound();和return Ok(objectValue);等方法中受益，如果返回类型为IActionresult，则Nswag生成的Csharp客户端方法的返回类型为FileResponse。 如果我将返回类型更改为某个类，则从生成的方法中返回相同的返回类型。这将阻止使用我之前提到的好处。 通常，返回类型来自已知的返回类型，从不返回匿名类型。 我已经设法从FileResponse读取Stream并将其转换为具有泛型方法Json
浏览 22提问于2019-12-19得票数 2
回答已采纳
我们的项目是将C#和F#与ASP.NET核心混合在一起。ASP.NET核心默认为Newtonsoft，用于在任何地方序列化/反序列化，而swagger文档生成(nswag)也依赖于CLI(可变的)-like DTO来生成正确的类型。
我们的DTO在F#中定义如下：
[<CLIMutable>]
type Query =
{ Status: string
Offset: int
Limit: int }
这使得Newtonsoft可以序列化，nswag可以生成swagger文档。
但是..！对于空/选项“不匹配”，我感到非常困难。C#/Newtonso
浏览 0提问于2019-05-22得票数 3
回答已采纳
1回答
我正在尝试为Trello API生成一个C#客户端。因此，我从下载了Open API规范，并从bash运行以下nswag命令。
nswag openapi2csclient /input:swagger.v3.json \
/classname:TrelloClient \
/namespace:Integrations.Trello \
/output:TrelloClient.cs \
/GenerateClientInterfaces:True \
/GenerateExceptionClasses:True \
/GenerateClie
浏览 15提问于2021-05-05得票数 1
1回答
我正在使用NSwag为我的ASP.NET 6 API生成一个Swagger文档。我的应用程序使用强类型ids，这些ids是带有value属性的简单记录。
public record Id(Guid Value);
在控制器方法中使用这些in作为参数。示例：
public class MyController
{
[HttpPost]
public void Test(Id id) {}
}
从执行的角度来看，这是很好的。我有一个自定义的模型绑定和一个工厂，自动处理从GUID字符串绑定。对于自定义json转换器处理此操作的序列化，也是如此。为了确保NSwag正确地生成字符串属性
浏览 2提问于2022-07-17得票数 0
回答已采纳
我正在使用清洁架构解决方案建立一个新的API：
如果我们将重点放在API的返回类型上。
1- 200 -此API规范是生成精细的(基于在控制器中的动作的返回类型)
例如对于get/TodoItems
"/api/TodoItems": {
"get": {
"tags": [
"TodoItems"
],
"operationId": "TodoItems_GetTodoItemsWithPagination",
"responses"
浏览 7提问于2022-06-27得票数 1
回答已采纳
没有明确的文档说明如何使用NSwag扩展自动生成的TS文件。我指的是带有保护器访问修饰符的扩展方法
以下是与NSwag所有者的讨论：
但在随后的步骤中存在一些不确定性。尤其是在向控制器的名称添加静态后缀和/或前缀的情况下。
有人能清楚地解释一下我们如何扩展自动生成的方法吗？
浏览 8提问于2020-05-17得票数 0
我有一个带有不同API控制器的Web项目。 当使用NSwag创建客户端时，所有控制器的所有方法都放在同一个API客户端中。 如何为每个API控制器获取一个ApiClient？ 提前谢谢。
浏览 43提问于2021-01-05得票数 0
我试图从一个c#规范中生成openApi代码，该规范在一些带有swagger 3的属性上缺少类型元素。
缺少类型的属性是在代码中生成的，也没有类型，这是一个编译器错误。
据我所知，类型在openApi规范中并不是强制性的，但是难道不应该有一些退步来使spec、object或string保持代码编译吗？
是否有任何傲慢的选择来强制这种行为，或有其他的想法如何解决这个问题？
问候
浏览 8提问于2022-08-01得票数 0
因此，我使用swagger和Nswag很长一段时间了，我可以看到自动生成的方法用于生成这样的一行以作为默认值退出：
return _observableOf<MyClassData>(<any>null);
...And现在具有相同的nswag文件，它以这样的方式生成：
return _observableOf(null);
这似乎对角9有效，因为它不支持strict=true，但是现在对于我的角11/12项目来说，这会引发一个错误，即：
error TS2322:键入‘可观察’不能分配到键入‘可观察’。输入'null‘不能分配给键入'MyClassD
浏览 0提问于2021-08-01得票数 4
我在使用Asp.Net Core3.1生成的Swagger Angular客户端时遇到了困难。 我创建了一个ASP.NET核心应用程序，并在TestController.cs中添加了以下内容 [HttpGet]
[Route("TList")]
[Produces("application/json")]
public ActionResult<TestDto> TList()
{
TestDto result = new TestDto();
result.Title = "Title";
result.DataLis
浏览 14提问于2019-12-23得票数 1
回答已采纳
我已经将解决方案中的所有项目更新为使用.net6，并将nswag json文件更新为runtime到Net60。
我安装了.net 6.0.100。
这是构建输出
$ dotnet build Solution.sln
Microsoft (R) Build Engine ersion 17.0.0+c9eb9dd64 for .NET
Restored C:\src\...\Client.csproj (in 455 ms).
NSwag command line tool for .NET Core Net60, toolchain v13.15.10.0 (NJsonSchema v
浏览 32提问于2022-03-14得票数 0
回答已采纳
我以一种非标准的方式编写Web控制器，将参数作为动态对象来获取。
这给NSwag带来了一个问题。因为方法定义中没有参数，所以NSwag无法生成所需的内容。
我想知道在这种情况下是否可以使用NSwag。也许我可以在方法中添加一些属性，以便NSwag能够生成API？
[HttpPost]
[ActionName("create-account")]
public IHttpActionResult CreateAccount()
{
var body = Request.Content.ReadAsStringAsync().Result;
dynamic jso
浏览 0提问于2019-01-19得票数 1
是否有一种方法可以指定自定义或调用某些方法或程序来生成nswag.json的swaggerGenerator部分中的输出swagger规范？
标准的fromSwagger生成器似乎只使用一个输出路径，因此作为最后的手段，我可以使用来创建在那里命名的文件。但是，在nswag.json中直接指定我的生成器似乎不那么麻烦。
"swaggerGenerator": {
"fromSwagger": {
"output": "swagger.json"
}
}
浏览 0提问于2018-11-03得票数 0
回答已采纳
1回答
发布命令运行良好，但在运行之后，我必须恢复项目，因为有缺少的包.
因此，如果我运行以下命令：
dotnet发布--运行时双赢-x64
然后发表的作品，但我有丢失包在我的项目之后。
但是，如果我在没有运行时的情况下运行发布：
dotnet发布
然后，出版工作很好，我没有任何丢失的包。
这是正常的行为吗？我能做些什么来解决这个问题？这真烦人。
这是我的csproj文件：
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcor
浏览 0提问于2019-06-26得票数 8
回答已采纳
我有以下MSBuild脚本：
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
...
<BuildDependsOn>
NSwag;
$(BuildDependsOn)
</BuildDependsOn>
<!--<AfterTransform>NSwag</AfterTransform>-->
</PropertyGroup>
<ItemGroup>
..
浏览 0提问于2019-08-11得票数 0
回答已采纳
我正在尝试从.yaml文件生成.NET Core Web API控制器。
下面是一个运行此命令的示例：
dotnet "/.../dotnet-nswag.dll" openapi2cscontroller /input:https://somewhere.com/swagger.yaml /classname:MyResource /namespace:Com.Example.MyResource /output:Controllers/ResourceController.cs /UseLiquidTemplates:true /AspNetNamespace:"M
浏览 30提问于2019-11-05得票数 2
我正在使用下面的代码为我的Blazor WebAssembly项目生成一个WebAssembly客户端API。
using (HttpResponseMessage response = client.GetAsync("https://localhost:5001/swagger/v1/swagger.json").Result)
{
using (HttpContent contentapi = response.Content)
{
var json = contentapi.ReadAsStringAsync().Result;
浏览 15提问于2022-03-20得票数 1
我希望能够在我的rest客户端项目中删除nswag.json和swagger.json，并自动生成cs代码。 另外，如果项目是最新的，不要再次构建它。
浏览 72提问于2020-10-02得票数 2
回答已采纳
在使用Linq- to -SQL、向现有表添加列以及在新列上设置默认值时，Linq to SQL似乎忽略了默认值。其他人有没有经历过这种行为？有没有办法修复它，使Linq- to -SQL或SQL Server自动设置默认值？
我添加的列的类型为Bit，缺省值设置为1。
浏览 7提问于2009-07-13得票数 25
回答已采纳
我有许多JSON模式文件，并使用NSwagStudio生成C#客户端类
它自己的每个输出都很好，但不幸的是，每个json文件中都有一些常见的元素
是否有自动合并输出？
..。我可以手动编辑各种.cs文件，但是我希望这是自动构建过程的一部分。
浏览 1提问于2017-02-20得票数 0
回答已采纳
我们正在尝试将System.Text.Json集成到REST和rest客户机中，之前使用的是Newtonsoft。
我们使用nswag CSharpClientGenerator.GenerateFile通过代码(而不是nSwag Studio)生成REST客户端。
由于属性名称和json名称之间的大小写不同，项不能正确反序列化。我们已经能够通过设置PropertyNameCaseInsensitive = true来克服这一问题。
我们可以通过如下的部分类来完成这一任务：
partial class MakeClient
{
partial void Upda
浏览 10提问于2022-05-06得票数 0
1回答
即使在设置nswag version /runtime:NetCore31之后，nswag help命令和其他命令也会引发以下错误：
NSwag NPM无法找到任何兼容的框架版本--“Microsoft.NETCore.App”，没有找到版本“2.1.0”。-在/usr/share/dotnet/shared/Microsoft.NETCore.App找到了以下框架: 3.1.3
您可以通过安装指定的框架和/或SDK来解决这个问题。
指定的框架可以在：- child_process.js:660抛出错误；^
Error: Command failed: dotnet "/us
浏览 1提问于2020-05-01得票数 1
1回答
if(emailVal == '') {
$("#email").after('<span class="error"><font color="red">Please enter your email address.</span>');
hasError = true;
}
当我使用上面的javascript时，消息显示在email textbox旁边
<form:input path="
浏览 3提问于2011-09-27得票数 0
1回答
如果对象有一个嵌套的对象数组，那么在我的角项目中使用NSwag时，当试图发送数据时，会抛出一个错误：
export interface IJobAdDto {
mainJobAd: JobAddDetailsDto;
differentLanguageJobAds: JobAddDetailsDto[] | undefined;}
但是，如果我将它“转换”到它应该已经具有的类型的新对象，它会工作：
问题是，如何让NSwag进行此更改，或者如何扩展此方法/类，使其不会在每次生成时覆盖它？
我已经用NSwag(13.9.4.0)生成了客户端代码。
错误：
浏览 3提问于2020-12-21得票数 0
回答已采纳
我需要添加自定义头，但无法弄清楚。我正在尝试使用新的services.AddOpenApiDocument()而不是services.AddSwaggerDocument()。我想在我的整个API上添加这些自定义头部，而不仅仅是单个方法或控制器。我试图添加一个操作处理器，但是当我加载swagger UI时，我收到以下错误：“无法呈现此组件，请参阅控制台”。
下面是我的ConfigureServices()中的代码片段
services.AddOpenApiDocument(document =>
{
...
// this works fi
浏览 0提问于2019-04-23得票数 5
回答已采纳
我有一个ASP.Net核心3.1后端，和一个类型记录3.8前端。
我试图告诉NSwag注入授权头，如文档：中的页面所示
(确切地说，我的extensionCode文件是在那里提供的)
然而，当NSwag构建我的输出TypeScript文件时，我的extensionCode位于文件的底部。这意味着上面生成的类不能引用它，我得到了TypeScript编译错误。如果我手动将代码移到顶部，它就能工作。
我在NSwag代码中看到，似乎有一种方法可以使扩展代码按预期的方式呈现在顶部，而且它似乎与extendedClasses有关，但对于我的生命而言，我无法让它工作。我也尝试过添加extends gener
浏览 2提问于2020-05-04得票数 1
如果创建带有swashbuckle支持天气预报webapi。 然后，使用已连接的服务创建控制台应用程序，从而成功构建客户端。 例如，这可以很好地工作。 [HttpPost("Transform2")]
public IAsyncEnumerable<WeatherForecast> Create()
{
async IAsyncEnumerable<WeatherForecast> answer()
{
yield return new WeatherForecast
浏览 35提问于2021-10-04得票数 0
1回答
我有一个CMD脚本，它使用"nswag swagger2csclient“生成一个客户端，用于与另一个API进行通信。它以前曾经起过作用，但是一旦它使用了Nswag的更新版本，事情就开始出错了。
代码如下所示：
// Controller method
[ProducesResponseType(typeof(IEnumerable<CarViewModel>), 200)]
public async Task<ObjectResult> GetCars()
//Generated result with an older version of Nswag
S
浏览 0提问于2019-06-10得票数 0
3回答
我们正在对API进行版本控制，并使用ASP.NET Core1.1中的Swashbuckle生成Swagger规范。我们可以根据这些JSON规范文件生成两个API文档：
<!-- language: c# -->
services.AddSwaggerGen(setupAction =>
{
setupAction.SwaggerDoc("0.1", new Info { Title = "Api", Version = "0.1", Description = "API v0.1" });
se
浏览 4提问于2018-05-30得票数 3
回答已采纳
2回答
我正在使用NSwag生成我的TypeScript客户端(Angular格式)，但由于循环依赖关系，我在实现持有者令牌身份验证时遇到了问题。
我的用户服务需要导入TS客户端以使用令牌DTO，并且我的TS客户端需要导入用户服务以注入令牌。
因此，我想知道是否可以将生成的文件拆分为两个(或更多)客户端和模型文件。
另一种选择是在HTTP请求上实现一个拦截器，但我发现这很可恶，因为如果我使用另一个API，它可能会导致问题。
浏览 1提问于2019-02-18得票数 4
1回答
我正在生成构建swagger.json的一部分，使用我的csproj的一部分。
<Target Name="NSwag" AfterTargets="Build">
<Exec Command="$(NSwagExe_Net50) run nswagconfig.nswag /variables:Configuration=$(Configuration)" />
</Target>
我遇到的问题是，应用程序接口在运行时从Azure应用程序配置中加载配置对象，就像这样在我的Program
浏览 0提问于2021-03-04得票数 1
使用，存在一个Visual扩展，用于用为web服务生成代码。
这就引出了以下问题:是否有一种基于Rider中的swagger.json引用创建web服务引用的方法？
浏览 1提问于2022-07-28得票数 1
回答已采纳
1回答
我使用NSwag SwaggerToCSharpClientGenerator来生成请求和响应类以及枚举。
我有一些Web API方法，它们共享相同的枚举作为参数或请求对象的一部分。当我运行枚举API时，它多次生成相同的枚举定义，但命名为Enum1、Enum2、Enum3、ResponseClassEnum。
我可以配置NSwag (或Swashbuckle)，只生成一个枚举吗？
我的NSwag代码如下所示：
var document = SwaggerDocument.FromUrlAsync(
"http://localhost:5003/swagger/v1/s
浏览 1提问于2017-09-17得票数 2
1回答
nswag生成的服务没有返回逻辑
、、、、
我有一个用户登录的asp.net WebAPI服务，需要一个电子邮件和密码。api方法具有以下签名。LoginDto有两个字段，电子邮件和密码。 public async Task<IActionResult> Login(LoginDto dto) 一旦用户通过身份验证，WebAPI将返回一个具有令牌和Id的对象： return Ok(new { Token = GenerateJwtTokenFromClaims(claims), Id=user.Id }); 在客户端(Blazor app)，我通过运行nswag run使用了nswag命令行工具，它“成功”
浏览 41提问于2020-12-29得票数 1
回答已采纳
我试图使用NSwag生成一个自定义响应示例值。当使用Swashbuckle时，它有，但我不知道如何在NSwag中实现它。
我找到了这个，但是我还不太熟悉Swagger来翻译代码。
有没有人有关于如何实现此功能的完整示例？
浏览 1提问于2018-05-22得票数 2
回答已采纳
我有一个非常基本的ServiceStack实验，它使用Swagger生成文档。该服务可用于几种不同的内容类型(XML、JSON等)：
但是，我只能在Swagger中使用内容类型/json。是否有可以使用的配置/属性，以便测试其他内容类型？
浏览 3提问于2016-02-04得票数 1
回答已采纳
1回答
将VS连接服务(NSwag)注入到类/控制器中的首选方法是什么？我在网上找到了很多关于使用这个表格的建议： services.AddHttpClient<IClient, Client>((provider, client) =>
{
client.BaseAddress = new System.Uri("https://some.baseurl/");
}); 但是，这会导致错误 {"errorMessage":"Unable to resolve service for type 'Sys
浏览 58提问于2021-09-26得票数 7
回答已采纳
我最近开始使用ASP.NET样板作为我正在从事的一个项目的起点- Asp.NET核心Web Api + Angular，但我很难找到一些关于我认为是常见使用问题的信息。我会尽我所能解释我的意思。
我想要做的是有一个API端点，它接受一个参数，该参数需要限制为一组特定的值-因此，我想使用Enum来实现这一目的。
就参数验证而言，这一切都很好用，但我对如何使用swagger和Nswag为fontend生成的共享代理服务感到困惑。
在文档参数示例中，枚举参数显示为整数，因此仅通过查看swagger文档并不能清楚可用值集是什么，因为int值对于正在查看文档的用户没有任何意义。
让我们举一个这样的例子，
浏览 31提问于2018-12-18得票数 3
1回答
NSwag对斯瓦什巴克尔
、、、
我在中读到“用于.NET的两个主要的OpenAPI实现是Swashbuckle和NSwag”，但我找不到它们之间的区别。我该怎么选择呢？
浏览 1提问于2021-07-20得票数 32
有没有什么变量或属性可以让我在msbuild命令中用来从.csproj获取所有的项目引用？
NSwag.exe webapi2swagger /assembly:@(GimmeAllReferencies?) /controller:Namespace.MyController /output:SwaggerFiles/MyControllerSwagger.json
编辑:为我的不准确之处道歉。我有一个项目A，它有对项目B，C，D的项目引用。我需要知道的是这个项目的dll在哪里，以便在我的后期构建任务中使用它们。这是我现在得到的：
<Target Name="AfterBuil
浏览 1提问于2016-08-05得票数 3
1回答
我们正在使用NSwag为我们的API生成swagger页面。我们有一个虚构的asp.net核心2.2控制器，生成的swagger页面如下所示： ? 是否可以更改示例值的内容(以黄色突出显示)？我们想要显示testParameter的实际样本值，而不仅仅是"string“。有没有我们可以使用的数据注释，或者可以用来覆盖这种行为的其他覆盖机制？ 我们使用的NSwag版本是NSwag.AspNetCore 13.0.2。 定义模型的类是： public class TestQuery : IRequest<TestResponse>
{
[DefaultValue(
浏览 16提问于2019-09-10得票数 2
回答已采纳
我正在使用带有Asp.Net核心应用程序接口的NSwag。我想将默认的accepted从application/octet-stream改为application/json。 ? 我尝试向API action和OpenApiMimeType添加Response属性，但都不起作用。它仍然设置为application/octet-stream。我如何改变这一点？ 更新:以下是API的操作之一。 [HttpPost("login")]
public async Task<ActionResult> Login(LoginDto dto, string retur
浏览 27提问于2020-09-21得票数 1
我正在尝试用我自己的.css样式表定制swagger。
我使用的是and内核2.1和NSwag.AspNetCore 12.2.5。
我搜索了一下，发现在以前的版本中，这可以通过嵌入我的自定义样式表，然后将其插入到中间件配置中，这样做的方法如下：
app.UseSwagger(o =>
{
o.InjectStylesheet("/css/custom.css");
});
在最新版本的NSwag中，这似乎已经更改为：
app.UseSwaggerUi3(cfg =>
{
cfg.CustomStylesheetUri = new Uri("/c
浏览 1提问于2019-05-05得票数 3
回答已采纳
1回答
我正在尝试使用OpenAPI规范生成一个Rest客户端，该规范发布在亚特兰蒂斯上，用于Jira云。
我试过使用Swagger、Openapi生成器和NSwag Studio。未编译任何自动生成的Rest客户端。我曾尝试为.Net 4.X和.Net 6生成，但没有工作。
请让我知道如何验证OpenAPI规范是否引起了问题。如果这导致了问题，那么是否有一个选项可以修复OpenAPI规范并生成Rest客户端？我不喜欢对自动生成的代码做任何更改。
谢谢
浏览 39提问于2022-06-10得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
