我正在使用 NSwag 为我的 ASP.NET 6 API 生成一个 Swagger 文档。 我的应用程序使用强类型 id,它们是具有 value 属性的简单记录。 public record Id(Guid Value); 此类 id 用作控制器方法中的参数。 例子: public class ...
我正在使用 NSwag 为我的 ASP.NET 6 API 生成一个 Swagger 文档。 我的应用程序使用强类型 id,它们是具有 value 属性的简单记录。 public record Id(Guid Value); 此类 id 用作控制器方法中的参数。 例子: public class ...
我正在尝试将 swagger 集成到我们的应用程序中。 我在一个独立的应用程序中尝试了这个,一切都很顺利。 我对我们的应用程序进行了类似的更改,但是当我使用 [FromBody] 而不是 [FromQuery] 时,swagger 页面为空(未提供 API 定义)。 我不知道发生了什么; 看起来枚举 ...
在 ASP.NET 内核 - Web API 项目中使用在 ApiController 和[Route]属性中修饰的[ApiExplorerSettings(GroupName = "<group-name>")]我想参考上面的GroupName属性值。 另请注意,我在同一个 cont ...
我已将Microsoft.AspNetCore.Diagnostics.HealthChecks样式的健康检查添加到我的应用程序中,如Microsoft 在此处记录的那样。 我也在使用Swashbuckle生成 swagger 文档。 然后我使用NSwag生成客户端 API 供我的其他应用程序使用。 ...
我正在研究Asp.net Web API项目。 我最近使用config.Services.GetApiExplorer();为文档创建了一个端点config.Services.GetApiExplorer(); 在生产中隐藏此端点并仍可将其提供给团队中所有其他开发人员的最佳方法是什么。 ...
对于返回模型的端点,我们可以使用ResponseTypeAttribute告诉帮助页面文档,返回数据将是什么样的: 这将在“ Api帮助”页面上提供一个不错的条目,描述此端点的行为。 我想证明某个端点将返回应用程序/ zip二进制流。 我怎样才能做到这一点? ...
ASP.NET Core 1.0 是否支持使用 APIExplorer? 我找不到关于它的任何文档或如何使用它,有没有人使用过它并且可以分享一些见解? ...
我通过使用ExpandoObject作为参数,为Web.API项目创建了一种非常整洁的实现PATCH方法的方法。 如下图所示: 但是,在生成文档时,ApiExplorer对ExpandoObject的处理感到迷茫,这是完全可以理解的。 有人会对如何操纵ApiExplorer提供一些合 ...
我正在使用[FromBody]正常工作在基于MVC的Web api上发布一些字符串。 数据正在添加到数据库中。 我的控制器的Action方法类型为HttpResponseMessage,我正在返回此响应 但是错误事件正在触发而不是成功。 这是ajax调用。 建议我一些解 ...
我的WebApi控制器位于程序集(自托管OWIN应用程序或ASP MVC应用程序)中。 是否可以通过其他应用程序(通过WebApi控制器动态加载程序集)使用ApiExplorer生成Web API文档? ...
所以我一直在谷歌上搜索很多东西来尝试解决这个问题,但我似乎找不到任何关于它的东西。 请参阅图片以供参考,但我正在尝试填写主体参数的“描述”字段。 做这个的最好方式是什么? ...
我的大多数api路由都按以下方式分段: /api/{segment}/MyEntity (即“ / api / SegmentA / MyEntity”) 在其中定义了ModelBinder的地方,该ModelBinder将从字符串转换为Segment对象,如下所示: 配置为 ...
我的WebApi中有几个方法返回HttpResponseMessage。 由于响应类型未知,我必须使用类似的东西在HelpPageConfig中注册它们 config.SetActualResponseType(typeof(X), "SomeController", "GetX"); ...
如何使用apiController和angular删除多个记录? 我已经尝试了以下方法。 但是我没有成功 api控制器: ajax方法: 删除记录工作正常。 若要删除多个记录,则会发生以下错误: ...
我正在尝试在我的后端系统中添加API文档。 默认的ApiExplorer和帮助页面工作非常好,直到我向Api控制器引入版本。 为了添加版本,我在Controllers文件夹下创建了子文件夹: V1 V2 V3 并在那里有基于版本的Api控制器。 为了让 ...
我正在使用Web API帮助页面与Web API 2(5.0) - 两个最新的Nuget包。 我希望帮助文档显示属性的注释,这些类是参数或在HttpResponseMessage的主体中返回。 例如,我有一个像这样的控制器方法: 我想在MyClassType1和MyClassTy ...
使用http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages文档指南并在每个公共API控制器上应用这些指南 但不知何故,我的Summaries评论没有被XML生成器ApiExplorer接收 ...
有没有办法让ApiExplorer自动生成请求样本? 我试过用: 在HelpPageConfig.cs中,但出现了两个问题: 它需要我为特定的控制器和动作定义特定的类型,我正在寻找更通用的东西,如果添加了新的控制器\\类型,则不需要添加\\更改代码。 我只能为每个 ...
我正忙着创建Web API(在asp mvc4应用程序中)。 我正在使用asp.net网站上建议的库来生成文档( http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages )。 我的问题是, ...
您可以使用ApiExplorerSettingsAttribute设置IgnoreApi属性以不生成帮助信息来装饰控制器或操作方法。 如果尝试将相同的内容应用于操作方法的属性,则会收到错误消息: 错误2属性'ApiExplorerSettings'在此声明类型上无效。 它仅对“类 ...