如何让OpenAPI/Swagger忽略模型的某些属性？
OpenAPI/Swagger是一种用于描述和定义RESTful API的规范，它可以帮助开发者自动生成API文档、客户端SDK等工具。在使用OpenAPI/Swagger时，有时候我们希望忽略模型中的某些属性，可以通过以下几种方式实现：
- 使用
@JsonIgnore注解：在模型类中，可以使用@JsonIgnore注解标记某个属性，表示在生成的API文档中忽略该属性。例如，对于Java语言，可以使用Jackson库提供的@JsonIgnore注解。 - 使用
@ApiModelProperty注解：在模型类中，可以使用@ApiModelProperty注解标记某个属性，并设置hidden=true，表示在生成的API文档中隐藏该属性。例如，对于Java语言，可以使用Swagger提供的@ApiModelProperty注解。 - 使用
x-扩展属性：在OpenAPI规范中，可以使用x-开头的扩展属性来定义一些非标准的属性。可以在模型的属性中添加x-ignored: true，表示在生成的API文档中忽略该属性。
需要注意的是，以上方法都是在模型定义中进行的，不同的编程语言和框架可能有不同的实现方式。在使用OpenAPI/Swagger时，可以根据具体的语言和框架文档来查找相应的注解或配置方式。
对于推荐的腾讯云相关产品和产品介绍链接地址，可以参考腾讯云的官方文档和开发者社区，其中包括但不限于以下产品：
- 腾讯云API网关：提供了API管理、发布、调用等功能，可以帮助开发者更好地管理和使用API。详细信息请参考腾讯云API网关。
- 腾讯云函数计算：提供了无服务器的计算服务，可以帮助开发者快速部署和运行代码。详细信息请参考腾讯云函数计算。
- 腾讯云容器服务：提供了容器化应用的管理和运行环境，可以帮助开发者更好地部署和管理容器化应用。详细信息请参考腾讯云容器服务。
请注意，以上推荐的产品仅供参考，具体选择和使用还需根据实际需求和情况进行评估。
相关·内容
1回答
在我的ASP.NET Core3.1API中，我有两个区域，每个区域都有模型。我正在尝试生成2个swagger文档，每个文档对应一个区域。根据IOperationProcessor过滤操作，所有操作均正确。但是，每个文档都包含来自这两个区域的所有文档。 控制哪个文档中包含哪些模型的方法是什么？ 这是我目前所拥有的： services.AddOpenApiDocument(swagger =>
{
swagger.DocumentName = "admin";
swagger.OperationProcessors.Add(new Swagger.Admi
浏览 15提问于2020-04-02得票数 1
有谁知道如何在Swagger 2.0定义中定义可能的'enum‘值，以便它们显示在OpenAPI UI的模型选项卡中？示例如下:对于status属性，有一个枚举选项。如何在OpenAPI 2.0中定义这样的枚举？
浏览 1提问于2014-12-22得票数 62
1回答
我需要在我的spring引导API中支持swagger 2和3。
我使用docket创建了swagger 2&对于swagger 3，我刚刚添加了maven依赖项springdoc-openapi-ui。能够检查2和3的文件。
如何禁用/只启用swagger 3或swagger 2？我的意思是，如何禁用swagger 3配置？
我没有使用@profile启用/禁用swagger 3配置类。只需添加springdoc-openapi-ui maven依赖项swagger 3就可以了。
浏览 2提问于2019-10-01得票数 3
1回答
我想知道如何重命名生成的swagger.json ? 当我通过“添加新的OpenAPI服务引用”选项将OpenAPI服务引用添加到Visual studio 2019中的项目中时。 ? 我假设它应该类似于使用"ClassName“完成的操作。 <ItemGroup>
<OpenApiReference Include="OpenAPIs\swagger.json" CodeGenerator="NSwagCSharp" Namespace="PetStore.Client">
浏览 50提问于2020-09-21得票数 2
我有下面的springboot rest控制器，使用的是springdoc-openapi。我的springboot服务必须迎合一些遗留应用程序(这是唯一调用该服务的客户端)，并且我需要将HttpServletRequest作为参数。
我正在生成swagger openapi文档，当我到达swagger-ui.html时，我看到rerquest正文来自uri path = '/personhttprequest‘的Httprequest param方法，但当param为HttpServletRequest时不会。我在这里看到了
但我不清楚为什么以及如何让HttpServletReque
浏览 0提问于2020-07-06得票数 1
我想描述一下带有RESTful 2.0 (Swagger2.0)的OpenAPI接口的XMLResponse负载。但是，我很难在OpenAPI数据模型中描述特定的XML标记。
我无法让Swagger在这个表单中创建一个适当的示例XML标记，在开始和结束的XML标记之间有一个属性和内容：
<Person id="bar">foo</Person>
文档()只描述了如何对带有子标记(type: object)的标记或带有内容的标记(type: string)建模，而不是同时对两者进行建模。
我尝试过这样做，Swagger编辑器接受它时没有任何错误或警告：
d
浏览 5提问于2017-02-03得票数 9
回答已采纳
(这是我的第一次堆叠溢出帖子，所以对我放松点，哈哈)
我在用：
-OpenApi (v3)
-L5-Swagger ( swagger-php和swagger-ui的包装器)
我使用注释来生成OpenAPI规范。规范是在没有控制台错误的情况下生成的。但是，在每个模型的每个属性中，一旦生成属性，就会添加一个附加属性。
我试过：
重写模型，
以不同的方式重写属性
我的模型之一& "id“属性：
/**
* Class ActionPlan
*
* @OA\Schema(
* description="Action Plan
浏览 1提问于2019-08-08得票数 2
回答已采纳
我成功地在java中使用Swagger/OpenApi v2.0使用OpenApi Generator CLI 3.3.2-SNAPSHOT生成了一个REST客户端。
但是我已经有了一个REST客户端，所以我只想从规范中生成一些模型。
当我跑步时，我会获得成功：
java -Dmodels -DmodelDocs=false \
-jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
-i swagger.json \
-g java \
-o /tem
浏览 0提问于2018-10-23得票数 2
我有一个端点，它的查询参数使用了方括号：
GET /info?sort[name]=1&sort[age]=-1
这里，name和age是我的模型定义中的字段名。
如何为这些参数编写OpenAPI (Swagger)定义？
浏览 9提问于2018-01-29得票数 8
回答已采纳
我正在使用Maven的openapi-yaml生成器将一个swagger文件转换为一个开放的API v3文件。
我想要做的是将新文件直接放到某个目录中。
但是会生成一些我不需要的附加文件，例如README.md、.openapi-generator/VERSION、.openapi-generator-ignore
是否可以禁用此行为并仅生成.yaml文件？
浏览 2提问于2019-08-13得票数 7
API-Platform将生成Swagger/OpenAPI路由文档，然后生成模式(AKA模型)的以下文档( docs将它们显示为“模型”，但当前版本如2.7将它们显示为“模式”)。 生成的用于显示这些模式/模型的内容在哪里？如何删除其中的一些？显示它们的功能是Swagger-UI的一部分，但API-Platform必须负责提供JSON配置，从而更改API-Platform而不是Swagger-UI。请注意，this post显示了如何添加模式，但没有显示如何删除模式。除了this之外，还有没有关于这个主题的文档没有详细介绍？ 从下面的输出可以看出，我公开了AbstractOrganizat
浏览 33提问于2021-06-24得票数 0
我有openapi: 3.0.0 YAML文件，我正在寻找从模式生成测试数据响应(JSON对象)的方法。是我想要的，但我无法让它在openapi: 3.0.0中工作，代码非常适合"swagger"："2.0“定义。我尝试让代码与支持OpenAPI 3.0的Swagger库2.x一起工作。我知道我需要使用Swagger的2.x版本。
import io.swagger.parser.SwaggerParser;
import io.swagger.models.*;
import io.swagger.inflector.examples.*;
import io.swa
浏览 1提问于2019-05-03得票数 6
回答已采纳
2回答
我正在尝试合并micronaut swagger UI中的附加文件模式。我认为该文件在构建过程中不会被捕获，因此不确定如何为该附加文件设置正确的路径。
在资源内部，存在额外的文件。
在application.yml配置中，我设置了以下配置
micronaut:
openapi:
additional:
files= src/main/resources/swagger/swaggerSecuritySchemes.yml
swaggerSecuritySchemes.yml
securitySchemes:
Open Id Connect:
typ
浏览 0提问于2021-01-15得票数 2
1回答
我在OpenApi json数据验证方面遇到了问题。基于OpenApi验证(或editor.swagger.io)，我的JSON文件有未使用的模型。我应该消除这些警告，几乎所有的警告都来自System.Reflection命名空间。
示例：
: System.Reflection
- Unused model: PropertyInfo
- Unused model: MethodImplAttributes
- Unused model: FieldAttributes
- Unused model: EventAttributes
- Unused model: MethodAttribu
浏览 2提问于2021-05-21得票数 2
回答已采纳
1回答
假设我有一个类io.swagger.models.Swagger的对象，来自库io.swagger:swagger-models:1.5.24。如何将其转换为JSON？
我的目标是从REST定义创建一个json文件。我们在Scala中使用Finch/Finagle，这将是一个全新的功能；我希望它尽可能通用。我对这个设计有一个想法，但是它需要将Java模型转换成JSON，而且我还没有在Swagger中找到这个工具。
这是傲慢的v2。不知道它是什么版本的OpenAPI。如果也有生成swagger v3和相关的OpenAPI的方法，我们将不胜感激，但是swagger v2在这里是绝对必要的。
浏览 0提问于2019-11-04得票数 0
回答已采纳
我无法让swagger-codegen为在独立于主API定义文件的文件中定义的json模式生成类。我使用的命令是：
$ java -jar swagger-codegen-cli-2.2.2.jar generate -i api.json -l java -o gen -v
这是api.json的样子：
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Simple API",
"
浏览 2提问于2017-05-24得票数 0
我正在考虑将OpenAPI规范添加到我的web API项目中，但我遇到了各种我无法解决的障碍。
接口端点：/api/some_controller/some_method/id
内容主体需要来自http主体，但我不希望使用[FromBody]自动绑定，因为我需要按原样流式处理数据(审计等)。
我将swagger添加到我的项目中，但正如预期的那样，它没有显示body参数。
以下代码会生成正确的swagger API定义：
public void some_method([FromBody]MyType mytype);
但如前所述，我需要没有模型绑定的原始数据。
我对如何解决这个问题束手无策。我
浏览 3提问于2021-02-12得票数 0
我试图在现有json配置的基础上设置swagger，使用'org.springdoc:springdoc-openapi-ui:1.5.9'依赖项(spring + gradle)。
我拥有的是：
在我的“资源/静态”文件夹中自定义openapi.json文件
我的属性中的springdoc.swagger-ui.url=openapi.json
根据的说法，这应该就足够了
但我在试图打开swagger-ui.html时遇到了一个问题，它写着“获取错误未定义的openapi.json"：
查看浏览器开发工具和请求，我发现以下请求：
浏览 2提问于2021-07-20得票数 1
回答已采纳
我已经在外部安装了swagger，我只是想将swagger-ui (开放源码)实例连接到openapi.yaml的localhost:8000/doc/api (openapi.yaml)。有什么想法吗？PS :我试着用
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.components(new Components().addSecuritySchemes("basicScheme",
new SecurityScheme().
浏览 3提问于2020-10-14得票数 0
回答已采纳
所以我有一个spring boot项目，我刚刚在其中添加了OpenAPI Swagger UI。它可以很好地自动为我们所有的控制器和模型生成文档。但是我想添加一些额外的配置，比如externalDocs，如下所示。 externalDocs:
url: URL
description: DESC 但是因为它是自动生成的，所以我没有用于swagger的YAML。我尝试通过Bean添加它，但没有成功。 import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.Ope
浏览 50提问于2020-08-25得票数 0
回答已采纳
我在上跟踪openapi的micronaut，并且UI没有生成，每次我试图访问/swagger时，/swagger-ui都会出现以下错误：
{
"message": "Not Found",
"_links": {
"self": {
"href": "/swagger",
"templated": false
}
},
"_embedded": {
"errors": [
{
浏览 7提问于2022-10-21得票数 2
回答已采纳
1回答
我正在使用Python FastAPI编写一些Rest API。需要在Swagger - OpenAPI文档中添加大量自定义部分。这包括每个API的联系信息字段、作者信息、显示数据模型的图像、数据库字段等。 有没有办法使用Fast API built-in OpenAPI capabilities来完成这一切？我知道可以托管我们自己的自定义json文件。但我不知道如何将图像添加到swagger json文件中。我也不知道如何添加自定义字段。 有没有什么模板可以用来托管swagger文档的HTML版本？ 任何帮助都将不胜感激。
浏览 19提问于2021-08-15得票数 1
3回答
假设我有一个控制器，比如：
public class MyController {
public String endpoint1() {...}
public String endpoint2() {...}
}
无论出于什么原因，我想在春季禁用endpoint1。简单地说，就是禁用它，这样就不能访问它。因此，在这种情况下，我不需要寻找返回的方式和响应，也不需要寻找如何保护端点的安全。只是简单地禁用端点，类似于它上的@Disabled注释。
解决方案更新：
感谢所有贡献过的人。我决定接受@AdolinK的建议。但是，该解决方案只会禁用对控制器的访问，从而导致404未找到。但是，如
浏览 3提问于2022-05-26得票数 1
回答已采纳
在我的Spring应用程序中，我试图用OpenApi 3替换Swagger 2。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
...
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
浏览 15提问于2021-03-23得票数 2
正如标题所暗示的，有没有一种方法可以更改类型的swagger url
localhost:8080/myapp/swagger.ui.html
放入url中。
localhost:8080/docs
我使用OpenApi3，到目前为止，在文档中我不知道如何更改"swagger-ui“。感谢任何可能的答案
浏览 42提问于2020-11-13得票数 2
回答已采纳
我想通过url /v3/api-docs/设置默认方案，但有空的url和错误“没有API定义提供。”我应该使用哪些设置属性？
项目中的当前代码：
application.properties
springdoc.swagger-ui.disable-swagger-default-url=true
springdoc.swagger-ui.use-root-path=true
SwaggerConfig.java
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi applicationApi() {
浏览 24提问于2021-05-24得票数 0
情况：
服务器端在Web控制器中我得到了一个模型类，让我们称之为MyNamespace.MyData，它除了属性还具有业务逻辑功能，比如bool CanEditThis()方法。
在VisualStudio2017中，我使用“Add”“->”REST客户机生成客户端代码，以调用Web方法并返回数据，但这将为客户机生成一个新的模型类，如ClientNamespace.MyData (没有函数)，而不是检测已经存在一个可用的模型类MyNamespace.MyData (带有函数)。
使用服务器端的模型类在自己的项目中定义，并在DLL中为客户端和服务器端代码提供( WCF使用此设置
浏览 0提问于2018-02-20得票数 0
从Laravel 8升级到9，我收到了这条信息。
“无法呈现此定义所提供的定义没有指定有效的版本字段”。
请指定有效的Swagger或OpenAPI版本字段。
支持的版本字段是swagger："2.0“和匹配OpenAPI : 3.0.n的字段(例如，OpenAPI :3.0.0)。
有人建议增加
openapi="3.0.0"
行，但我能在哪里加呢？当我加入
@OA\Info()
它仍然抛出一个错误，就像
意外字段"openapi“用于@OA\Info()
浏览 8提问于2022-06-07得票数 0
我从swagger-ui github添加了文件夹dist，并在index.html中提供了openapi.yaml的路径 url: "/openapi/openapi.yaml" 现在我可以通过地址http://localhost:63342/dropwizard-example/com/example/dropwizard/dist/index.html或通过文件index.html访问来查看UI 我如何通过我的路径提供UI？类似于: dropwizard-project-work.com:8080/dist
浏览 23提问于2021-08-04得票数 1
回答已采纳
我已经使用Java项目的pom文件中的以下构件安装了swagger-ui：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.2</version>
</dependency>
<dependency>
<groupId>org.springdoc&l
浏览 5提问于2021-01-21得票数 3
我对String和Swagger 3很陌生。如何更改默认的API描述，即Swagger springdoc-openapi-ui swagger 3中的OpenAPI definition
还有版本，开发者信息..。
我在用
implementation "org.springframework.boot:spring-boot-starter-web:2.6.6"
implementation "org.springdoc:springdoc-openapi-ui:1.6.8"
在搜索中，我只看到它们显示默认的Swagger
浏览 12提问于2022-04-28得票数 4
回答已采纳
1回答
我正在寻找一种为API中使用的JSON对象声明扩展元数据的方法，该API是使用Swagger/OpenAPI指定的(或者，如果有另一种格式支持所请求的特性，则类似的内容)。
这样做的目的是使用这些元数据自动/部分地生成用户界面来编辑这些数据。
所要求的功能清单：
对用户可读信息的多语言支持，如名称、描述、占位符、示例-- API规范本身的名称和描述可能与CRUD编辑器应该看到的最终用户不同。
验证元数据
我知道Swagger/OpenAPI中有不同的字段，如最小值、最大值、模式等等，但是没有办法为验证指定特定的(多语言)错误消息(比如“用户名必须只包含字母和数字”，并翻译成多种语言)。
浏览 4提问于2016-04-11得票数 3
我正在开发一个应用程序，它使用库为其Spring控制器生成OpenAPI v3端点。这个库使用来实际将OpenAPI对象映射到OpenAPI模式。
控制器使用的请求/响应类型包括Object类型的属性。
public class TypeWithObject {
private Object value;
public Object getValue() { return value; }
public void setValue(Object value) { this.value = value; }
}
因此，这种类型可以是OpenAPI定义的任何OpenAPI
浏览 1提问于2021-09-20得票数 1
我使用来生成我的服务器代码，Echo Lab堆栈作为服务器。当我将Group实例传递给Openapi.RegisterHandlers而不是Echo实例时，对于该组中的任何请求，总是会收到{"message":"no matching operation was found"}的400个错误：
swagger, err := Openapi.GetSwagger()
if err != nil {
fmt.Fprintf(os.Stderr, "Error loading swagger spec\n: %s",
浏览 8提问于2021-11-23得票数 3
回答已采纳
我刚刚弄明白了如何使用我自己的openapi.json文件启动和运行swagger，并使用以下命令：
docker run -p 80:8080 -e SWAGGER_JSON=/foo/openapi.json -v ~/source:/foo swaggerapi/swagger-ui
openapi.json文件在源代码管理中，可以在许多地方运行。
除了将其放入自述文件之外，还有什么方法可以使这个命令更容易地重新运行呢？我能用一个Dockerfile吗？或者我能用码头写作吗？最重要的部分只是让它变得简单，然后使更改/添加选项变得容易。
我也知道我可能需要一个bash脚本，我可以改变，但我
浏览 3提问于2019-04-10得票数 3
回答已采纳
我看了很多，但没有找到任何解决我的问题的方法:它是固定的，一种代码优先的方法将被使用，我想知道如何实现它，OpenApi (Swagger)将在我的Java / Spring应用中考虑像@Min(), @Max(), @Size(), ...这样的验证注释。每当我让generate到OpenApi文档时，这些注释就会被忽略；它们根本不会被显示出来。
目前我尝试使用
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</a
浏览 2提问于2021-08-01得票数 2
我将把我的API服务器集成到Google Cloud Endpoint。 到目前为止，Google Cloud Endpoint支持swagger 2.0。 但我的依赖项/库现在是升级版本。因此，我希望在不降低swagger库版本的情况下生成swagger 2.0YAML文件(api端点已经使用swagger 4.x - openapi 3.0规范进行了描述)。 Nestjs和swagger依赖项(package.json)： ...
"@nestjs/common": "^7.0.0",
"@nestjs/config": "^0.
浏览 42提问于2020-06-19得票数 2
回答已采纳
在我的春季引导应用程序中，在应用程序启动时，我正在生成多个json格式的swagger文档，并存储在位置-静态/标记文件。我能够通过在application.properties中提到路径来读取文件，如下所示
application.properties
springdoc.swagger-ui.urls[0].url=/swaggerdoc/openapi.json
springdoc.swagger-ui.urls[0].name=openapi
springdoc.swagger-ui.urls[1].url=/swaggerdoc/openapi1.json
springdoc.sw
浏览 6提问于2022-01-26得票数 1
回答已采纳
我目前正在使用Swagger库：
在我的示例模型类中，如下所示：
/** @OA\Schema(
* title="ProductPromotion",
* @OA\Property(property="id", type="integer"),
* @OA\Property(property="uid", type="string"),
* @OA\Property(property="store_id", type="integer"),
* )
*/
cla
浏览 2提问于2019-12-17得票数 1
回答已采纳
我们正在使用swagger记录我们的JAX-RS API。通过使用swagger-jaxrs2包，我们可以很好地创建一个构建我们的api文档。 我们唯一想要更改的是:默认的"openapi"-Url。通过注册Swaggers OpenApiResource类，我们的应用程序每次都会生成默认的"[host]/openapi"端点。 我们可以创建我们自己的端点来服务openapi-spec，但是我们不能禁用这个默认端点。 每个提示都是受欢迎的！提前给你加满油。
浏览 25提问于2020-04-24得票数 1
回答已采纳
我正在尝试创建一个Swagger配置来显示我的几个apis。它们不是公开托管的，定义文件在我的本地文件系统中。我用的是装腔作势的ui和码头。我使用以下命令运行它：
docker run -p 8080:8080 -v $(pwd)/_build:/spec swaggerapi/swagger-ui
在_build目录中，我有yaml规范文件。这是swagger-config.yaml配置文件：
urls:
- /spec/openapi2.yaml
- /spec/openapi.yaml
plugins:
- topbar
我也尝试过：
urls:
- url: /spec
浏览 8提问于2022-01-20得票数 0
回答已采纳
我使用Swagger (OpenAPI)来设计和实现一个API。我已经有了一个功能性swagger.yml和一个Maven项目，用于基于它构建文档、服务器和客户端。
swagger-codegen-maven-plugin在/target/generated-sources/swagger目录中生成抽象类和实现类。我应该用自己的实现类覆盖实现类，所以我将实现类的初始版本移到/src/main/java目录中。
在移动类之后，我的构建正确地完成了，但是如果我做了一个mvn clean compile，我就会在我的构建中出现重复类的错误。
每次我做一个干净的构建时，swagger-codegen-
浏览 5提问于2016-12-21得票数 3
回答已采纳
我也想把这个反应写在“傲慢的医生”里！我在django中使用drf_yasg应用程序。我写了这段代码：
@swagger_auto_schema(method='post', request_body=openapi.Schema(
type=openapi.TYPE_OBJECT,
properties={
'login_id': openapi.Schema(type=openapi.TYPE_STRING, description='ID'),
浏览 24提问于2022-09-16得票数 -1
我正在尝试按照go-swagger教程将身份验证添加到我的api中：https://goswagger.io/tutorial/composed-auth/ 但是我生成的代码变成了： type GetAuthenticatedUserHandlerFunc func(GetAuthenticatedUserParams, interface{}) middleware.Responder 而在示例中，它是： type AddOrderHandlerFunc func(AddOrderParams, *models.Principal) middleware.Responder 我似乎找不到如
浏览 9提问于2019-09-11得票数 1
回答已采纳
如何使用Swagger记录GraphQL？我们有一个庞大的后端REST API，最近部分开始使用GraphQL。为了记录API，我们使用Swagger。
问题是:如何使用Swagger(OpenAPI)来记录GraphQL端点？在Swagger或GraphQL的官方文件中绝对没有相关信息。
浏览 4提问于2020-09-11得票数 14
在添加自定义REST路由/资源之后，我尝试将Swagger模块集成到Drupal 8中。我已经安装了OpenAPI、OpenAPI_UI和OpenAPI_Rest模块，在安装所有模块后导航到<mysite>/openapi/rest时，我能够获得一个有效的swagger资源。
我现在遇到的问题是如何让Swagger模块在OpenAPI模块中呈现。在导航到Administration -> Configuration -> Web Services -> OpenAPI Resources之后，我可以选择Explore with Swagger按钮，它应该使用按照以
浏览 0提问于2021-05-04得票数 4
在生成的OpenAPI文档中，springdoc-openapi库自动将某些属性标记为required。例如，注释为@NotNull的属性将包含在所生成的YAML文件中的必需属性列表中。 该库不做的一件事是将可选属性标记为nullable: true。但是，默认情况下，Spring Boot应用程序将接受请求中的null，并在可选属性的响应中返回null。这意味着OpenAPI文档和端点的行为之间存在差异。 手动将任何单个属性标记为可为空很简单:只需将@Schema(nullable = true)添加到字段或访问器即可。但是，在具有多个属性的大型模型中，我希望以与required属性相同的
浏览 146提问于2021-09-24得票数 2
1回答
几天前，我在JavaEE 7中启动了一个REST，我用三个方法实现了一个类，并在项目中成功地实现了Swagger和Swagger-UI，其中显示了我在生成的JSON中成功实现的三个端点。
然而，我迁移到了JavaEE 8，在这个更改之后，Swagger检测到了几个未知的端点，比如“默认”端点(这个捕获只显示了其中的一部分)：
我研究了一下，发现这些端点可能属于Eclipselink实现中的parameters，正如这里所描述的和，尽管它们出现在生成的JSON中，但它们都包含变量路径，因此我无法按照Swagger提供的路径访问它们，甚至可以使用上面的例子创建"version“之
浏览 5提问于2019-10-25得票数 4
我有一个springboot应用程序，我想转换成Micronaut，但是我如何通过代码配置openapi，如本文所示
代码片段：
@配置公共类OpenApiConfig {
@Bean
public OpenAPI customOpenAPI(OpenApiProperties properties) {
var openApi = new OpenAPI()
.info(getInfo(properties));
return openApi;
}
private Info getInfo(OpenApiProperties properties
浏览 9提问于2022-07-07得票数 1
考虑这个OpenAPI模式：
Units:
type: array
properties:
empty:
type: boolean
items:
$ref: '#/components/schemas/Unit'
Swagger编辑器按如下方式渲染它：
我应该如何解释“empty”属性？为什么它被视为有序映射？
通常，数组中有items，但没有直接properties。
浏览 31提问于2021-07-30得票数 2
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
