Questions tagged «swagger»

Swagger是一个框架实现，用于基于OpenAPI规范来描述，生成，使用和可视化RESTful Web服务。

9
如何使用Swashbuckle在WebAPI上从Swagger文档中省略方法
我有一个C＃ASP.NET WebAPI应用程序，带有使用Swashbuckle自动生成的API文档。我希望能够从文档中省略某些方法，但似乎无法弄清楚如何告诉Swagger不要将它们包括在Swagger UI输出中。 我感觉这与添加模型或模式过滤器有关，但操作不明显，文档似乎仅提供了如何修改方法输出的示例，而不是将其从输出中完全删除。 提前致谢。
134 c#  asp.net  .net  swagger 
5
如何将Swagger API导入Postman？
最近，我用SpringMvc和swagger-ui（v2）编写了宁静的API 。我注意到邮递员中的导入功能： 所以我的问题是如何创建Postman需要的文件？ 我不熟悉Swagger。
113 swagger  postman 
10
如何配置Spring Security以允许无需身份验证即可访问Swagger URL
我的项目有Spring Security。主要问题：无法访问http：// localhost：8080 / api / v2 / api-docs上的大写URL 。它说缺少或无效的授权标头。 浏览器窗口的屏幕快照 我的pom.xml具有以下条目 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> SwaggerConfig： @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { ApiInfo apiInfo = new …
11
将Swagger规范JSON转换为HTML文档
对于一些用PHP编写的REST API，我被要求创建Swagger文档，由于我不知道向这些现有API添加注释并创建此类文档的任何简便方法，因此我现在使用此编辑器生成了一些文档。 我保存了使用该编辑器创建的JSON和YAML文件，现在我需要创建最终的交互式Swagger文档（此语句听起来可能很幼稚又含糊）。 有人可以让我知道如何将Swagger JSON规范文件转换为实际的Swagger文档吗？ 我在Windows平台上，对Ant / Maven一无所知。
3
在Spring MVC应用程序中实现Swagger的“简单”方法
我有一个用简单的Spring编写的ReSTFul API（没有Spring Boot，没有花哨的东西！）。我需要在其中实现Swagger。到目前为止，互联网上的每个页面都以令人困惑的配置和肿的代码（使我根本无法移植）而使我发疯。 有没有人有一个示例项目（或一组详细的步骤）可以帮助我实现这一目标？特别是，我正在寻找使用swagger-springmvc的良好示例。我知道它有“样本”，但充其量，深奥的代码令人不快。 我必须澄清，我不是在寻找“为什么Swagger就是最好的”。我没有使用（或当前的任务将不使用）Spring Boot等。
2
Swagger / OpenAPI-使用$ ref传递可重用的已定义参数
假设我有一个类似的参数limit。这个地方到处都是，如果我需要更新它，那么到处都必须更改它是一个痛苦的事情： parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 我可以使用$ ref在其他地方定义它并使其可重用吗？我碰到了这张票，暗示有人想更改或改进功能，但是我不知道它是否已经存在？
4
昂首阔步的继承与组成
在我的“简化” API中，所有响应都是从基本“响应”类派生（继承）的。响应类由填充有元数据的标头和包含用户请求的核心数据的正文组成。布置响应（以JSON格式），使得所有元数据都位于第一个“层”上，并且body是这样一个称为“ body”的单个属性 response |--metadata attribute 1 (string/int/object) |--metadata attribute 2 (string/int/object) |--body (object) |--body attribute 1 (string/int/object) |--body attribute 2 (string/int/object) 我尝试使用以下JSON来定义这种关系： { ... "definitions": { "response": { "allOf": [ { "$ref": "#/definitions/response_header" }, { "properties": { "body": { "description": "The body of the response (not metadata)", "schema": { …
81 swagger 
9
如何在Swagger UI中发送带有请求的自定义标头？
我在API中一些端点- ，。/user/login/products 在扬鞭UI我交的email，并password以/user/login和为响应我收到一个token字符串。 然后，我可以从响应中复制令牌，并希望将其用作Authorization请求中的标头值到所有url（如果存在），并/products作为示例。 我应该在Swagger UI页面上的某个位置手动创建文本输入，然后将令牌放到那里并以某种方式注入请求中，或者是否有工具可以更好地管理它？
3
如何基于现有邮递员收藏生成招摇？[关闭]
已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗？更新问题，使其仅通过编辑此帖子来关注一个问题。 2年前关闭。 改善这个问题 我正在开发REST API。在开发过程中，我使用邮差（chrome扩展名）来使用和记录我的API。这是一个很棒的工具，并且我拥有大多数的API端点。但是，在即将发布时，我想大声地记录一下这个API，我该怎么做？有没有一种方法可以使我根据邮递员的出口而招摇呢？
30
ASP.NET Core-Swashbuckle不创建swagger.json文件
我在获取Swashbuckle.AspNetCore（1.0.0）包来生成任何输出时遇到麻烦。我阅读了swagger.json文件，应将其写入“〜/ swagger / docs / v1”。但是，我没有得到任何输出。 我从一个全新的ASP.NET Core API项目开始。我应该提到这是ASP.NET Core2。该API可以正常工作，并且我可以从值控制器中检索值。 我的启动类的配置与本文（GitHub上的Swashbuckle.AspNetCore）完全相同。 public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) …
4
如何从Swagger API声明生成JSON-Schema
我有使用服务的Swagger API声明 Swagger v 1.2的 我对Swagger的最初感觉是，它非常接近JSON Schema（草案3和最近的Draft 4），并且为请求和响应对象生成JSON Schema相对容易。 但是，虽然Swagger的一部分重用了JSON Schema结构，但事实证明，它仅使用功能的子集，并且还在Models中引入了它自己的继承（usingsubTypes和discriminator）。 问题：是否有任何现有项目或代码段，可以 从Swagger API声明生成可用的JSON模式？ 最佳JSON模式草案4，并使用Python（但我很乐意找到任何东西）。
12
大张旗鼓地生成静态文档
有没有为swagger 2.0创建静态文档的方法？也许就像editor.swagger.io上的“预览”。 我需要获取静态html文件，以便可以将它们包含在某些静态文档中。 到目前为止，我还没有找到一种方法来执行此操作。我看到有swagger-codegens静态文档，但这仅适用于swagger <= 1.2。
72 swagger 
2
有任何Springfox替代品吗？
最近两年，我与Springfox合作开发了Spring Boot应用程序。Springfox为您的REST API生成文档和测试ui。太棒了 但是实际上Springfox项目已经死了，并且不支持最新的Spring。我有三个问题 还有其他直接生成Swagger UI的方法吗？还有其他图书馆/项目吗？ 如何在Spring Boot项目中实现swagger ui？ 也许已经过时了，对于Spring Boot来说，有没有更好的选择？ 更新 经过数月的大量使用和测试 SpringDoc OpenApi 我会说这不是springfox的替代品，它要好得多！稳定，易于使用且最新！ 我可以100％推荐这个！我们将所有项目迁移到SpringDoc OpenApi。
5
NET Core 3.0的JWT身份验证和Swagger
我正在使用.Net core 3.0开发一些Web Api，并希望将其与SwashBuckle.Swagger集成。它工作正常，但是当我添加JWT身份验证时，它无法按我预期的那样工作。为此，我添加了以下代码： services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" }); c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme { Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", Name = "Authorization", In = ParameterLocation.Header, Type = SecuritySchemeType.ApiKey }); }); 添加AddSecurityDefinition功能后，我可以看到“授权”按钮，当我单击它时，会看到以下表单： 然后输入Bearer …
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.