-
6 votesanswersviews
SwashBuckle / Swagger - OAuth资源所有者密码流
我正试图在我的Asp.Net Web API中实现招摇,我遇到了一个问题 . 我正在使用密码资源所有者流,我不得不添加一个解决方案来执行此操作,这包含在以下堆栈溢出问题中: - Swagger/Swashbuckle: OAuth2 with Resource Owner Password Credentials Grant 我已经完成了所有工作,通过javascript将Bearer令牌添加到当... -
2 votesanswersviews
使用WebApi2身份令牌的Swashbuckle / Swagger
我正在尝试使用 Swashbuckle 为我的Web API项目设置swagger . 我使用 builtin 身份验证(Asp.net身份)和 builtin 默认API路径 /Token 来授予访问令牌 . 我还设法将这个自定义路径添加到swagger规范中 . 有没有办法告诉Swagger使用从 /Token 获得的承载令牌来对受保护的API区域进行授权API调用? 我已尝试在 Swagge... -
27 votesanswersviews
在Swashbuckle中启用持票人令牌(Swagger文档)
我创建了一个使用 Individual Account Security 的asp.net webapi应用程序,以便默认启用Bearer令牌 . 它工作正常,所以我能够在Postman中测试它们没有问题 . 当我尝试通过Swashbuckle集成Swagger UI时,问题就出现了 . 我通过以下方式安装了Swashbuckle: Install-Package Swashbuckle 然后... -
1 votesanswersviews
使用Swagger / Swashbuckle测试受Azure AD B2C保护的.NET Core WebAPI
我按照我发现的指令here,为ASP.NET Core修改它们 . 以下是Startup.ConfigureServices(...)中的修改配置: 这是Startup.Configure(...)中的修改配置 但问题是,当我在本地部署WebAPI时,swagger看起来像这样: -
0 votesanswersviews
AutoRest生成的API客户端Azure API服务不会抛出任何错误
我们使用Swashbuckle从我们的api服务生成swagger,然后使用Visual Studio中的ADD Azure API Client函数生成API客户端 . 除了服务器遇到问题并引发错误的情况外,此客户端工作正常 . 此服务器错误导致客户端继续等待并且永远不会返回错误,因此不会触发错误 . 同步和异步调用都会发生这种情况 . 抛出错误的唯一方法是将超时设置为短时间,在这种情况下抛出一... -
4 votesanswersviews
使用Swagger命名AutoRest生成的方法名称
我正在玩AutoRest和Swagger项目 . 我的Web API控制器有一个名为 GetAllAsync 的方法 . 当我为服务生成客户端时,客户端有一个接口 IResourcesOperations ,其中 Resources 是控制器的名称 . 该接口有一个名为 GetAllAsyncWithHttpMessagesAsync 的方法 . 然后有一个名为 ResourcesOperatio... -
3 votesanswersviews
Swagger文档中的AutoRest - IEnumerable <long>生成为IEnumerable <long?>
我有一个使用ASP.NET MVC 5,Swashbuckle和AutoRest的项目 . 当我使用Autorest为我的API生成客户端时,我的参数正从 IEnumerable<long> 转换为 IEnumerable<long?> 控制器方法 [HttpPost] public IHttpActionResult Foo([FromBody] IEnumerable&... -
1 votesanswersviews
使用Autorest.exe与ADD-> Rest API Client时使用不同的客户端输出
我正在尝试使用Swagger为WebAPI生成客户端代码 . 我通常通过下载元数据json文件(在部署WebAPI之后)然后对客户端类库使用选项“Add-> Rest API Client ..”来实现 . Add -> Rest API Client . 这将生成客户端库到所需的项目,并正常工作 . 但我正在尝试使用Autorest.exe自动执行此过程 . 我用parameters... -
2 votesanswersviews
Swagger - Web API - 可选的查询参数
[HttpGet] [Route("students")] [SwaggerOperation(Tags = new[] { "Student" })] [SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResponseModel<IList<Student>>))] [Swagger... -
6 votesanswersviews
Headers 中的API密钥与swashbuckle
我想在一个带有Swashbuckle的WebAPI项目上进行基于API密钥的身份验证(swagger for .net) . 我已将swashbuckle配置如下: config .EnableSwagger(c => { c.ApiKey("apiKey") .Description("API Key A... -
2 votesanswersviews
Swagger Api doc with generics
我使用Swashbuckle(5.2.2)和Swagger来创建我的WebAPI项目的文档 . 我需要创建一个静态文档,所以我在生成的json上使用swagger2markup,这很好用 . 但是,我的API中有很多泛型类型用于分页,资源等 . 许多返回类型看起来像这样: Page<Resource<MyType>> 因此,在文档中我得到了很多( A LOT )冗余定义 .... -
1 votesanswersviews
如何在请求的 Headers 中设置多个api Key和Swashbuckle
我've a web api2 project, where I'已实现swashbuckle用于测试和记录我的Web服务 . 我试图在SwaggerDocsConfig中设置apiKey进行身份验证,但是如果我想添加另一个apiKey( apiKey 和 appId ),我就无法使其正常工作 . 我在swagger doc中读到了可能,但我不知道如何用swashbuckle以这种方式配置swag... -
0 votesanswersviews
如何为Swagger Api生成API密钥
这是我第一次使用Swagger API,我一直在试图找出为文档中的[authorize]字段生成API密钥的最佳方法 . 大多数博客和教程都很不清楚,或者只是简单地向api添加一个授权按钮,这不是我想要的 . 我希望能够将生成的密钥放入标头并运行授权任务 . 对我来说最好的方法是什么?我应该生成JWT令牌吗?但是,我如何将其链接到swagger API? -
0 votesanswersviews
Swashbuckle生成的Swagger在Azure API Management中创建了重复的版本路径
我正在尝试配置Azure API管理以使用版本控制,并使其与Swashbuckle生成的Swagger / Open API文档一起使用 . 我有一个包含2个版本的API - 1.0和2.0 . 我已经配置Swashbuckle来生成2个单独的Swagger文档,每个版本一个 . 都好 . 版本控制方案是按路径进行的,因此消费者需要调用正确的路径(v1.0或v2.0) . 像这样:https:... -
1 votesanswersviews
Swagger UI不会在POST中显示image / png内容
我有一个POST方法返回“image / png”内容的场景 . API在Postman中完美运行,我能够看到图像 . 我使用Swagger来记录我的API . 由于某种原因,“试用”功能会导致任何返回图像的POST方法崩溃 . 它冻结加载,我在浏览器控制台中看到以下内容: cannot parse JSON/YAML content swagger-ui-min-js:14 Uncaught... -
15 votesanswersviews
如何在Swagger中显示WebApi OAuth令牌 endpoints
我创建了一个新的Web Api项目,添加了Asp.Net Identity并配置了OAuth,如下所示: OAuthOptions = new OAuthAuthorizationServerOptions { TokenEndpointPath = new PathString("/Token"), Provider = new ApplicationOAut... -
2 votesanswersviews
根据roles / api_key生成Swashbuckle API文档
我正在使用Swashbuckle(5.3.2),它会生成一个很好的API文档 . 为了澄清我的问题,我 Build 了一个没有实际意义的小例子项目 . API只能与有效的API密钥一起使用 . 为此我引入了一个ApiKeyFilter来验证api_key并读出相应的角色 . ApiKeyFilter public class ApiKeyFilter : IAuthenticationFilter... -
4 votesanswersviews
Identity Server 4 Swagger身份验证
我目前在使用swagger授权对身份服务器4的api调用时遇到问题 .我的招摇依赖是使用swashbuckle版本-beta客户端对象在身份服务器4中看起来像 new Client { ClientId="swagger", Enabled = true, ClientName="Swagger", AllowedGrantT... -
2 votesanswersviews
使用swashbucle启用swagger时出错
我正在尝试使用几个简单的控制器创建一个WebApi项目 . 如果我使用fiddler调用方法一切都很好,但我更喜欢使用swashbuckle,因为它有点漂亮 . 但是,使用默认配置安装swashbuckle时它无法正常工作 . 当我导航到http://localhost/api/mycontroller/swagger 它重定向到http://localhost/api/mycontroller/... -
3 votesanswersviews
Swagger(Swashbuckle)UI无法从远程主机加载
我已经在.NET Web API项目的顶部实现了Swagger(通过Swashbuckle),当从localhost运行时,它都可以正常工作 . 但是,当我通过IIS在远程计算机上托管时,UI加载速度非常慢(1分钟),并且只加载标头,而不是 endpoints . 我在IIS中为站点启用了CORS,并在“EnableSwagger”方法中添加了以下扩展名 . c.RootUrl(req =>... -
5 votesanswersviews
API获取和浏览器崩溃后,Swagger UI冻结
我有一个ASP.NET WebAPI项目,我试图用Swagger UI替换旧的XmlDocumentationProvider页面 . 我正在使用swashbuckle swagger for webAPI 5.3.1 nuget包 . 我能够导航到localhost / MyApp / swagger,我可以在fiddler中看到它调用localhost / MyApp / swagger / ... -
1 votesanswersviews
自定义swagger ui以分离文档
我使用swashbuckle 5.x和swashbuckle-Odata将swagger集成到我的Web API / OData项目中 . 如果我导航到http://root_url/swagger,我可以在一个大列表中看到所有可用的API文档 . 每件事情都很好,但我已经给了 list of Odata controllers and API(s) ,我需要 show in a separate... -
1 votesanswersviews
Swashbuckle XmlComments在本地工作,但在服务器上无法生成swagger
我有一个webapi项目,我正在利用swashbuckle框架来清除api文档 . 我已按照指示使用我的控制器和DTO构建文档xml文件,并且它在本地运行良好 . 但是,在生成swagger文档时,会引发500错误 . 我已经确认是否删除了我的xml注册行,生成了swagger doc并成功返回 . 这是我的注册行: GlobalConfiguration.Configuration.Enable... -
2 votesanswersviews
WebApi Swagger:API endpoints 空列表
Problem: Swagger在我的.NET WebAPI项目中运行正常,但未列出任何API endpoints . 这就是我得到的:http://localhost:62536/swagger/docs/v1 { "swagger":"2.0", "info":{ "version":... -
58 votesanswersviews
无法从Swagger UI中的文件问题中读取
我在我的应用程序中加入了swagger UI . 当我尝试看到swagger UI时,我很好地获得了API的文档但是在一段时间后它在按钮上显示了一些错误图标 . 错误消息如下所示: [{“level”:“error”,“message”:“无法从文件中读取http:// MYIP / swagger / docs / v1”}] 我不确定是什么导致它 . 如果我刷新它工作并在几秒后显示错误 .... -
1 votesanswersviews
ASP.NET Core 2.0 - Web API方法多个 endpoints
这是我的控制器: [Route("api/[controller]")] public class SaveRecordController : XivicControllerBase { #region REST Calls [HttpPost] public SaveRecordResponse Post([FromBody] SaveRecordR... -
1 votesanswersviews
将操作添加到默认路由时,路径模板分隔符'/'不能连续出现
我有一个通过OWIN中间件托管的Web API 2项目 . 一切都运行得很好,我可以按预期调用我的API . 但是,我的WebApiConfig定义了默认路由,如下所示: config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{action}/{... -
1 votesanswersviews
Web api IgnoreRoute
我已经创建了我的api的v2版本,所以我有两个控制器: UserController UserV2Controller 并设置了一条路线 "api/v2/user/{action}/{id}" 但是,也可以使用api / userv2 /来访问V2版本 我试过添加 config.Routes.IgnoreRoute("IgnoreUserV2", &qu... -
0 votesanswersviews
Swagger UI不暴露 endpoints
我们在.Net Web Api项目中有3个组件 . Framework (ClassLib):包含Controller Base,过滤器和依赖注入 DevHost (WebAPI app):充当Web API应用程序的入口点 API (ClassLib):包含控制器,模型,WebApiConfig和swagger配置 因此,SwaggerConfig类驻留在API库中 . 每当我试... -
8 votesanswersviews
利用属性版本控制在Swagger中利用MultipleApiVersions
使用属性路由时,是否可以在Swagger UI / Swashbuckle中利用MultipleApiVersions? 具体来说,我实现了版本控制: using System.Web.Http; namespace RESTServices.Controllers.v1 { [Route("api/v1/Test")] public class TestV1...