Tag: swagger ui

Swashbuckle Swagger UI：如何从xml注释中删除参数中所需的内容

我想更改控制器中某些参数的必需属性。 我使用XML注释来链接到Swagger。 这里的示例图像

如何让Swagger插件在自托管服务堆栈中工作

我已经通过github提供的示例重新提出了这个问题，并为任何想要自己运行代码的人提供了一个下拉框下载链接： Swagger没有在自托管的ServiceStack服务上工作 我在我的网站解决方案中运行了我的servicestack JSON服务，在’/ api / path下，但现在我想拆分该服务堆栈部分并将其作为自托管Windows服务运行。 我的问题是，我自己和其他开发人员发现Swagger插件对于测试目的非常有用，但现在它是自托管的，似乎HTTPHandler只设置为仅处理服务路由，而纯HTML不起作用。 我该如何解决？ URL： http://localhost:8081/Swagger-UI/Index.html 回应： Handler for Request not found: Request.HttpMethod: GET Request.HttpMethod: GET Request.PathInfo: /Swagger-UI/Index.html Request.QueryString: Request.RawUrl: /Swagger-UI/Index.html 安装Nuget包： ServiceStack ServiceStack.Razor @marfarma的更新 我的app.config文件里面没有任何相关的ServiceStack …… Program.cs： AppHostHttpListenerBase appHost = new my.HttpApi.myApiServiceHostBase(“My Service”, “my.ApiService”); string listeningURL = “http://localhost:8081/”; var appSettings = new ServiceStack.Configuration.AppSettings(); my.HttpApi.FakeProvider.ProductProvider.Init(appSettings); my.HttpApi.FakeProvider.UserProvider.Init(appSettings); #if DEBUG try { […]

使用授权标头（Bearer）设置Swagger（ASP.NET Core）

我有一个Web API（ASP.NET核心），我正在尝试调整swagger来进行调用。 这些调用必须包含Authorization标头，我正在使用Bearer身份validation。 来自Postman等第三方应用的电话也没问题。 但我遇到了设置swagger标头的问题（由于某种原因我没有收到标头）。 这就是现在的样子： “host”: “localhost:50352”, “basePath”: “/” , “schemes”: [ “http”, “https” ], “securityDefinitions”: { “Bearer”: { “name”: “Authorization”, “in”: “header”, “type”: “apiKey”, “description”: “HTTP/HTTPS Bearer” } }, “paths”: { “/v1/{subAccountId}/test1”: { “post”: { “tags”: [ “auth” ], “operationId”: “op1”, “consumes”: [“application/json”, “application/html”], “produces”: [“application/json”, “application/html”], “parameters”: [ { “name”: “subAccountId”, “in”: […]

使用swagger的Web API文档

我是新手，我已经看过几个在线文档，将Swagger实现到我的webapi，并使用SwaggerConfig的一些属性进行自定义。 以下是我的要求： – 我需要根据“API_Key”TextBox的值“浏览”按钮单击显示swagger文档，该值应与我的app.config键匹配。 所以我看到这样实现： – 用户来到我的招摇主页，默认情况下它将有空文档，除了图像中显示的标题。 在标题中提供的文本框中输入API_Key，然后单击“浏览”。 使用我的app.config中的密钥validation输入的API密钥，或者如果可能，在SwaggerConfig中validation。 如果validation了show documentation，则将错误消息显示为无效的API密钥。 需要建议。 亲切的问候，Raghu

在文档中对API方法进行分组 – 是否存在一些自定义属性

我有控制器喜欢 public class UserController : ApiController { [Route(“api/user”)] IHttpActionResult GetUser() { … } } public class ResumeController : ApiController { [Route(“api/user/resumes”)] IHttpActionResult GetResumes() { … } } 在swagger上产生的输出就像 有没有办法（除了通过推出自己的ISwaggerProvider或将两个控制器合并为一个来覆盖默认实现）来强制执行组名？ 就像是 public class UserController : ApiController { [Route(“api/user”)] [MagicalAttributeName(Group=”User”)] IHttpActionResult GetUser() { … } } public class ResumeController : ApiController { [Route(“api/user/resumes”)] [MagicalAttributeName(Group=”User”)] IHttpActionResult GetResumes() { […]

Web Api如何在Swagger中为所有API添加Header参数

我搜索了可能的方法来添加一个请求头参数，该参数将自动添加到我的web-api每个方法，但我找不到一个明确的方法。 在搜索时我发现方法OperationFilter()必须对它做一些事情。