问题标签 [swagger-3.0]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
node.js - Swagger 3.0.1 服务器生成器
当我在在线工具https://editor.swagger.io/中使用 swagger 3.0.1 生成 nodejs-server并尝试npm start
该项目时,我总是收到以下错误:
错误:找不到模块“./middleware/swagger.router”
spring - 来自swagger yaml的春季服务器存根
我正在使用来自 swagger yaml 的 spring 服务器存根来生成 POJO 类。在我的定义中,我为 Images 模型的 image 属性设置了 allOf 关键字。但是,生成的存根没有正确的类引用。它使用 Object 类而不是 Image 类类型生成。我在这里做错了什么?这是我的招摇 yaml。
这是生成的 POJO 类的图像
为什么类型是 Object 而不是 Image?
spring-boot - 如何使用springdoc在swagger openapi规范3.0的@RequestBody中创建多个模式?
我有下面的 api,我需要有两个内容类型的参数,application/x-www-form-urlencoded
因此我使用@RequestBody
而不是@Parameter
我需要 swagger.json 类似于下面的示例,但我不知道如何使用 springdoc 生成它。我也尝试了@ArraySchema,但我没有得到我需要的输出。我在语法上犯了一些错误,无法在线找到示例。
非常感谢任何帮助。TIA
node.js - 在 req.swagger.params 中无法访问 Open API 3.0 RequestBody,因为它在节点 API 中未定义
当我尝试访问 requestBody 时,它给了我错误无法访问未定义。
然后我通过打印req.swagger.params进行检查,它看起来像这样:
无法理解 requestBody 出现未定义键名的原因。
我现在如何访问 requestBody?
asp.net-core - Asp.NETCore 3.1 With Swagger launchUrl 在发布后不起作用
ASP.NET Core Web API 项目配置了 Swagger。当我在本地机器上运行项目时,launchUrl 可以正常工作并自动重定向到我的 Swagger apidocs 位置(https://localhost:44373/apidocs/index.html)
但是,一旦我在 Azure 上发布项目,launchUrl 就不再正常工作。 ( https://myapiurl.com ) => 是否应该自动重定向到( https://myapiurl.com/apidocs/index.html )?
对于已发布的环境,我缺少什么?
我的配置方法
c# - Swashbuckle SwaggerResponseRemoveDefaults 属性仍然向 Swagger 添加 200 Success 响应
我在 .NET Core 3.1 项目中使用 Swashbuckle 和 Swagger UI,并将我的 XML 注释导入 Swagger。我在控制器上有一个 POST 请求,我想在 Swagger 中注册多个响应状态(201、401、403、404)。问题是我还看到一个200 Successswagger.json
响应与我在文件和 Swagger UI 界面中明确指定的状态代码响应一起列出。
正如在多个不同的地方所建议的那样,我正在使用该[SwaggerResponseRemoveDefaults]
属性来尝试防止这种情况发生,但是我尝试的所有操作仍然会导致列出默认的 200 响应。
我试过了:
- 将属性添加到方法中,
- 将属性添加到控制器,
- 将属性添加到抽象基本控制器,
以及以上的所有组合。我还结合以下方法尝试了这些:
<response code="XXX"></response>
使用 XML注释标签指定所需的响应类型,以及[SwaggerResponse(XXX)]
使用端点指定所需的响应类型。
从我的 Swagger UI和swagger.json
.
TrackerController.cs
招摇.json
templates - 生成 API 代码时 Swagger Codegen 3 自定义模板错误
我遇到了这个问题。我有一些由 swagger-codegen-cli (swagger 2) 生成的代码,我正在更新以从 swagger-codegen-cli (swagger 3) 生成。
目前,我有一个带有修改后的 pom.mustache 的模板文件夹。
如果我使用 swagger codegen 2 和那个 templateFolder 运行:
java -jar SwaggerCodegen**2**/swagger-codegen-cli.jar generate -i swagger.json -l java -o . -c configFile -t templateFolder
一切正常。
但是,如果我使用 swagger codegen 3 jar 运行相同的命令,
java -jar SwaggerCodegen**3**/swagger-codegen-cli.jar generate -i swagger.json -l java -o . -c configFile -t templateFolder
我得到:
ERROR can't find model.mustache.
它会不断出错,因为它丢失了十几个不同的 .mustache 文件。
现在,我可以通过从完全不同的存储库中获取 Java .mustache 文件来修复这些错误。我去 swagger-codegen-generators,然后将所有 mustache 文件从 swagger-codegen-generators/src/main/resources/handlebars/Java/*.mustache 复制到我的模板文件夹中。
如果我这样做,那么当我跑步时
java -jar SwaggerCodegen**3**/swagger-codegen-cli.jar generate -i swagger.json -l java -o . -c configFile -t templateFolder
-last
在我更改为id
其中一个小胡子文件后,一切都编译得很好。
但这似乎是一个不可持续的解决方案。
(附带说明:如果我在不带 -t 的情况下运行命令,
java -jar SwaggerCodegen**3**/swagger-codegen-cli.jar generate -i swagger.json -l java -o . -c configFile
那么一切都编译得很好——但这对我不起作用,因为我需要编辑 pom.mustache 文件)
由此看来,在我看来,swagger codegen 2,如果它没有在 templateFolder 中找到它需要的一些默认模板文件,则会在自身(而不是 swagger-codegen-generators)中搜索那些丢失的 mustache 文件。但是,如果给定一个 templateFolder,swagger codegen 3 将只在该文件夹中查找——这意味着您的客户 templateFolder 必须包含所有相关的 mustache 文件。如果没有给 swagger codegen 3 一个 templateFolder,我认为它不是从它本身而是从 swagger-codegen-generators 中提取丢失的胡子文件。
这是真的?有没有不同的方法让我自动提取所有相关的胡子文件而不从另一个仓库复制?我只想在我的 templateFolder 中有 1 个已编辑的 pom.mustache 文件,并且能够运行所有内容。
swagger - 我需要在 springdoc-openapi 中为 @Parameter 添加多个示例,但这不会生成给定的示例
我正在尝试将 swagger 文档添加到我的项目中。我需要为 Sample.class 的@RequestBody 中的@Parameter 添加多个示例,以下代码是文档中提到的编写方式。
正在生成的 yaml 输出如下:
这似乎缺少应该按照代码添加的示例
google-cloud-firestore - 使用 firestore 配置 Swagger openAPI 3.0 身份验证时出现问题
我正在使用 swagger openAPI 来检索 Firestore 的数据。我想从 swagger 而不是从 firestore 应用安全性,当我这样做并执行 GET 请求 UI 显示存储在 firestore 上的数据而不显示未经身份验证的消息。