swashbuckle

Swashbuckle Swagger 生成一个实际的 guid

我正在使用 Swashbuckle 在我的 .Net Core WebAPI 项目中生成 Swagger。正如您在下面看到的,它生成一个字符串类型的 GUID。我想生成一个随机 Guid 并将“string”替换为“”或空 guid“00000000-0000-0000-0000-000000000000”。这将允许我的示例在我发布时实际工作。 { "payload": [ { ... »

c#

没有 HTTP 动词的 ASP.NET Core 错误处理程序引发 Swashbuckle 异常

在用于错误处理的docs 中有这样的内容: 警告 不要使用 HTTP 方法属性(例如 HttpGet)标记错误处理程序操作方法。显式动词会阻止某些请求到达操作方法。 所以它推荐这个: [ApiController] public class ErrorController : ControllerBase { //[HttpGet] <-- docs say ... »

c#

使用 swashbucle 启用招摇时出错

我正在尝试使用几个简单的控制器创建一个 WebApi 项目。如果我使用 fiddler 调用方法,一切都很好,但是我更喜欢使用 swashbuckle,因为它更漂亮。 但是,使用默认配置安装的 swashbuckle 无法正常工作。 当我导航到 http://localhost/api/mycontroller/swagger 它重定向到 http://localhost/api/mycon... »

Swashbuckle .NET Core 2 中 JWT 承载的授权

我使用身份验证服务为我的应用生成的令牌。那里没有问题。现在我引入了 Swashbuckle 来记录我的 API,我可以通过使用此代码在每个请求中发送 JWT 来进行如下身份验证; services.AddSwaggerGen(c => { var a = new ApiKeyScheme(); //c.AddSecurityDefinition("Bearer", new ... »

c#

List> 的 swagger/swashbuckle Ui 字段

我在 .net 5 Web API 应用程序中使用 swagger 5.6.3 在控制器中,我使用 DTO 对象 [HttpPost] public void create([FromForm] CDTO data) CDTO: public class CDTO { [Required] public string name { get; set; } [R... »

c#

Swagger XML 评论文件 - 缺少评论

我正在使用 Swashbuckle.Core 5.6.0 为我的 Web API 2 API 自托管 Swagger 文档 我在我的 Startup.cs 中启用 Swagger,如下所示 config.EnableSwagger(c => { c.SingleApiVersion("v1", "AUDM API"); c... »

如何为 SignalR 生成 API 文档

有没有办法做到这一点? 我已经为我的其他 API 生成内容,但我认为它不适用于 SignalR。 我对这里的同一件事非常感兴趣,尽管我越来越认为... »

c#

.NET & Swagger 开始出现 401 错误

我已经为我的 .NET Core webApi 应用程序配置了 Swagger,这是它的配置 public void ConfigureServices(IServiceCollection services) { services.AddAuth(); services.AddCors(options =>... »

在 Swagger 中设置示例

我正在使用 Swashbuckle.AspNetCore.Swagger (1.0.0) 和 Swashbuckle.AspNetCore.SwaggerGen (1.0.0)。我正在尝试在Default model example in Swashbuckle (Swagger) 之后向我的 API 添加默认示例。我创建了一个新的类文件并添加了, public class SwaggerDef... »

swagger swashbuckle 不支持嵌套类作为动作方法参数

我正在使用 asp.net 5 我有两个模型类,它们是嵌套的,两个内部类都命名为Command public class EditModel { public class Command { public int Id { get; set; } public string Info { get; set; } } } 和 public class Cr... »

Swagger/Swashbuckle 列出可接受的值?

我已在我的 Web API 应用程序上成功实现了 Swashbuckle/Swagger,但对输出不满意。 我的一个 web api 方法(一个企业事件记录工具)接受一个复杂对象值的 JSON 对象。 问题在于,当存在可以使用的可接受值的选定列表时,参数被列为字符串对象。我设置了默认值,因此如果发送了不正确的内容,我设置为默认值。 我想我可以添加其他返回可接受值的服务调用,但我宁愿不这样... »

SwaggerUI 不使用 Swashbuckle (5.x) 将 ApiKey 添加到 Header

我正在使用 Swashbuckle.AspNetCore 5.0.0 为我的 .Net Core WebApi 项目生成 Swagger 文档,并且在大多数情况下,一切正常。 我已经使用 ApiKey 设置了一些简单的身份验证,效果很好。 我现在遇到的问题是让 Swagger 在我的请求标头中添加一个 ApiKey。我按照这些不同帖子中提到的添加 ApiKey 安全定义/要求的说明进行操作:... »

使用 Swashbuckle 对 Swagger 页面的 Schemas 部分进行排序

在我的 Swagger 页面上,我(大部分)能够在 Swashbuckle 页面上订购操作 as described。 操作下方是“架构”部分,显示操作使用的数据结构。这些数据结构以任意顺序出现。我想对它们进行排序。 Swagger sort Schema Defintions 的问题表面上看起来像同一个问题,但在那个问题中,“排序”的含义是“将项目分类到不同的箱子中”,而不是我想要的“排序列表”... »

带着标题和价值大摇大摆

我正在使用 Swashbuckle 为我的 .NET 程序集生成 Swagger。我有一个具有非顺序和负值的枚举。像下面这样 [JsonConverter(typeof(StringEnumConverter))] public enum ShiftDayOffRule { /// <summary> /// Shift has no day off rule. ... »

c#

是什么导致了 swagger 已经在 Web API 2 的路由集合中的错误?

我在我的 ASP.Net MVC Core 项目中安装了 Swagger,它完美地记录了我的 API。 我的同事要求我将它安装在一个完整的框架 4.6.1 项目中,所以我完成了以下操作。 在包控制台管理器中运行: Install-Package Swashbuckle 要让您的测试 Web API 控制器正常工作: 1) 在 WebApi.config 中将其注释掉: // confi... »

Swagger Swashbuckle:带有查询参数的 POST API 端点

我需要帮助来覆盖 swagger 生成器以处理 API 端点,并在 swashbuckle 中记录查询参数 我找到了link,在 Drastic Method 中解释了如何覆盖 swagger 生成器 例如: 我有两个相同的路由定义端点: POST /api/customer(路由模板 -> /api/customer) POST /api/customer?f={f}&l={l}(路由模... »