279得票14回答
如何使用Swashbuckle在WebAPI上省略Swagger文档中的方法

我有一个C# ASP.NET WebAPI应用程序,使用Swashbuckle自动生成API文档。我希望能够从文档中省略某些方法,但似乎无法弄清如何告诉Swagger不要将它们包含在Swagger UI输出中。 我感觉这与添加模型或模式筛选器有关,但并不明显该怎么做,而且文档似乎只提供了如何修...

215得票8回答
如何将Swagger APIs导入Postman?

最近我使用SpringMvc和swagger-ui(v2)编写了restful API。我注意到Postman中的导入功能: 所以我的问题是如何创建Postman所需的文件? 对于Swagger我不太熟悉。

173得票7回答
如何在Swagger规范中使用'Authorization: Bearer <token>'?

我试图传达的是,身份验证/安全方案需要设置一个头部,如下所示: Authorization: Bearer &lt;token&gt; 这是我根据swagger文档所得出的内容: securityDefinitions: APIKey: type: apiKey n...

165得票1回答
如何在OpenAPI(Swagger)中定义一个可为字符串或null的属性?

我有一个JSON模式文件,其中一个属性被定义为string或null: "type":["string", "null"] 转换为YAML格式(用于OpenAPI / Swagger),它变成: type: - 'null' - string 但Swagger编辑器显示错误...

147得票5回答
在OpenAPI / Swagger文件中,正确声明日期的方式是什么?

在swagger文件对象中,声明日期的正确方式是什么?我认为应该是: startDate: type: string description: Start date example: "2017-01-01" format: date 但是我看到很多类...

144得票16回答
如何在Swagger UI中使用请求发送自定义标头?

我在API中有一些端点 - /user/login, /products。 在Swagger UI中,我将email和password发布到/user/login,并作为响应接收一个token字符串。 然后,我可以从响应中复制令牌,并希望在所有URL的请求中(如果存在),以及例如/prod...

135得票15回答
如何配置Spring Security以允许无需认证访问Swagger URL

我的项目使用了Spring Security。 主要问题:无法访问http://localhost:8080/api/v2/api-docs的Swagger URL,显示缺少或无效的授权头。 浏览器窗口截图 我的pom.xml文件包含以下条目&lt;dependency&gt; &l...

129得票36回答
Swashbuckle/Swagger + ASP.Net Core: "Failed to load API definition" Swashbuckle/Swagger与ASP.NET Core:API定义加载失败

我开发了一个ASP.NET Core 2应用程序,并包含Swagger。一切都很顺利,直到我引入了一个没有明确定义HTTP动作的方法:public class ErrorController : Controller { [Route(&quot;/error&quot;)] ...

126得票9回答
如何导出Swagger.json(或yaml)文件

如何导出 Swagger 定义文件?应该是一个 JSON 或 YAML 文件,例如 swagger.json 或 swagger.yaml。 假设我有一个端点看起来像 http://example.com//swagger/ui/index#!: 版本是 api version: v1。 我...

124得票13回答
将Swagger规范的JSON转换为HTML文档

有些用PHP编写的REST API,我被要求创建Swagger文档。由于我不知道如何注释这些现有的API并创建这样的文档,因此我使用了这个编辑器来生成一些。 我保存了使用该编辑器创建的JSON和YAML文件,现在我需要从中创建“交互式”Swagger文档。 请问有人能告诉我如何将Swagger...