问题：

SpringDoc openAPI工具不在Spring Boot Project中扫描API

曹昊焱

2023-03-14

我很难让这个工作。我已经开始了一个工作的SpringBoot（v2.2.2）应用程序与一个工作@RestController。为了让springdoc工作，我在pom中包含了以下依赖项：

 <dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.2.28</version>
</dependency>

然后我建立并开始我的服务。然后我浏览到api文档endpoint，我得到：

{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"paths":{},"components":{}}

我漏了一步吗？我假设在运行时它会扫描我的代码，找到@RestController，找到@刚需映射方法并从中生成api。

作为第二次尝试，我决定用swagger@Operation注释对我的一个方法进行注释，但仍然没有发现任何东西。

最后，我尝试使用springdoc手动指定带有控制器的包。packagesToScan和那也不起作用。

这感觉就像springdoc没有看到我的控制器...即使Spring看到了...它非常活跃，而且工作正常...

不确定我错过了什么...

以下是我的项目依赖项：

[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:2.2.2.RELEASE:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-autoconfigure:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-starter-logging:jar:2.2.2.RELEASE:compile
[INFO] |  |  |  +- ch.qos.logback:logback-classic:jar:1.2.3:compile
[INFO] |  |  |  |  \- ch.qos.logback:logback-core:jar:1.2.3:compile
[INFO] |  |  |  +- org.apache.logging.log4j:log4j-to-slf4j:jar:2.12.1:compile
[INFO] |  |  |  |  \- org.apache.logging.log4j:log4j-api:jar:2.12.1:compile
[INFO] |  |  |  \- org.slf4j:jul-to-slf4j:jar:1.7.29:compile
[INFO] |  |  +- jakarta.annotation:jakarta.annotation-api:jar:1.3.5:compile
[INFO] |  |  \- org.yaml:snakeyaml:jar:1.25:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-json:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- com.fasterxml.jackson.core:jackson-databind:jar:2.10.1:compile
[INFO] |  |  |  +- com.fasterxml.jackson.core:jackson-annotations:jar:2.10.1:compile
[INFO] |  |  |  \- com.fasterxml.jackson.core:jackson-core:jar:2.10.1:compile
[INFO] |  |  +- com.fasterxml.jackson.datatype:jackson-datatype-jdk8:jar:2.10.1:compile
[INFO] |  |  +- com.fasterxml.jackson.datatype:jackson-datatype-jsr310:jar:2.10.1:compile
[INFO] |  |  \- com.fasterxml.jackson.module:jackson-module-parameter-names:jar:2.10.1:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-tomcat:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-core:jar:9.0.29:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-el:jar:9.0.29:compile
[INFO] |  |  \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:9.0.29:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-validation:jar:2.2.2.RELEASE:compile
[INFO] |  |  +- jakarta.validation:jakarta.validation-api:jar:2.0.1:compile
[INFO] |  |  \- org.hibernate.validator:hibernate-validator:jar:6.0.18.Final:compile
[INFO] |  |     +- org.jboss.logging:jboss-logging:jar:3.4.1.Final:compile
[INFO] |  |     \- com.fasterxml:classmate:jar:1.5.1:compile
[INFO] |  +- org.springframework:spring-web:jar:5.2.2.RELEASE:compile
[INFO] |  |  \- org.springframework:spring-beans:jar:5.2.2.RELEASE:compile
[INFO] |  \- org.springframework:spring-webmvc:jar:5.2.2.RELEASE:compile
[INFO] |     +- org.springframework:spring-aop:jar:5.2.2.RELEASE:compile
[INFO] |     +- org.springframework:spring-context:jar:5.2.2.RELEASE:compile
[INFO] |     \- org.springframework:spring-expression:jar:5.2.2.RELEASE:compile
[INFO] +- com.google.guava:guava:jar:28.1-jre:compile
[INFO] |  +- com.google.guava:failureaccess:jar:1.0.1:compile
[INFO] |  +- com.google.guava:listenablefuture:jar:9999.0-empty-to-avoid-conflict-with-guava:compile
[INFO] |  +- com.google.code.findbugs:jsr305:jar:3.0.2:compile
[INFO] |  +- org.checkerframework:checker-qual:jar:2.8.1:compile
[INFO] |  +- com.google.errorprone:error_prone_annotations:jar:2.3.2:compile
[INFO] |  +- com.google.j2objc:j2objc-annotations:jar:1.3:compile
[INFO] |  \- org.codehaus.mojo:animal-sniffer-annotations:jar:1.18:compile
[INFO] +- org.apache.commons:commons-lang3:jar:3.9:compile
[INFO] +- org.springdoc:springdoc-openapi-ui:jar:1.2.28:compile
[INFO] |  +- org.springdoc:springdoc-openapi-webmvc-core:jar:1.2.28:compile
[INFO] |  |  \- org.springdoc:springdoc-openapi-common:jar:1.2.28:compile
[INFO] |  |     +- io.swagger.core.v3:swagger-models:jar:2.1.1:compile
[INFO] |  |     +- io.swagger.core.v3:swagger-annotations:jar:2.1.1:compile
[INFO] |  |     \- io.swagger.core.v3:swagger-integration:jar:2.1.1:compile
[INFO] |  |        \- io.swagger.core.v3:swagger-core:jar:2.1.1:compile
[INFO] |  |           +- javax.xml.bind:jaxb-api:jar:2.3.1:compile
[INFO] |  |           |  \- javax.activation:javax.activation-api:jar:1.2.0:compile
[INFO] |  |           +- com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:jar:2.10.1:compile
[INFO] |  |           \- javax.validation:validation-api:jar:2.0.1.Final:compile
[INFO] |  +- org.webjars:swagger-ui:jar:3.24.3:compile
[INFO] |  \- org.webjars:webjars-locator:jar:0.38:compile
[INFO] |     \- org.webjars:webjars-locator-core:jar:0.41:compile
[INFO] |        +- io.github.classgraph:classgraph:jar:4.8.44:compile
[INFO] |        \- org.webjars.npm:angular__http:jar:2.4.10:compile
[INFO] +- org.assertj:assertj-core:jar:3.14.0:test
[INFO] \- org.springframework.boot:spring-boot-starter-test:jar:2.2.2.RELEASE:test
[INFO]    +- org.springframework.boot:spring-boot-test:jar:2.2.2.RELEASE:test
[INFO]    +- org.springframework.boot:spring-boot-test-autoconfigure:jar:2.2.2.RELEASE:test
[INFO]    +- com.jayway.jsonpath:json-path:jar:2.4.0:test
[INFO]    |  +- net.minidev:json-smart:jar:2.3:test
[INFO]    |  |  \- net.minidev:accessors-smart:jar:1.2:test
[INFO]    |  |     \- org.ow2.asm:asm:jar:5.0.4:test
[INFO]    |  \- org.slf4j:slf4j-api:jar:1.7.29:compile
[INFO]    +- jakarta.xml.bind:jakarta.xml.bind-api:jar:2.3.2:test
[INFO]    |  \- jakarta.activation:jakarta.activation-api:jar:1.2.1:test
[INFO]    +- org.junit.jupiter:junit-jupiter:jar:5.5.2:test
[INFO]    |  +- org.junit.jupiter:junit-jupiter-api:jar:5.5.2:test
[INFO]    |  |  +- org.opentest4j:opentest4j:jar:1.2.0:test
[INFO]    |  |  \- org.junit.platform:junit-platform-commons:jar:1.5.2:test
[INFO]    |  +- org.junit.jupiter:junit-jupiter-params:jar:5.5.2:test
[INFO]    |  \- org.junit.jupiter:junit-jupiter-engine:jar:5.5.2:test
[INFO]    +- org.junit.vintage:junit-vintage-engine:jar:5.5.2:test
[INFO]    |  +- org.apiguardian:apiguardian-api:jar:1.1.0:test
[INFO]    |  +- org.junit.platform:junit-platform-engine:jar:1.5.2:test
[INFO]    |  \- junit:junit:jar:4.12:test
[INFO]    +- org.mockito:mockito-junit-jupiter:jar:3.1.0:test
[INFO]    +- org.hamcrest:hamcrest:jar:2.1:test
[INFO]    +- org.mockito:mockito-core:jar:3.1.0:test
[INFO]    |  +- net.bytebuddy:byte-buddy:jar:1.10.4:test
[INFO]    |  +- net.bytebuddy:byte-buddy-agent:jar:1.10.4:test
[INFO]    |  \- org.objenesis:objenesis:jar:2.6:test
[INFO]    +- org.skyscreamer:jsonassert:jar:1.5.0:test
[INFO]    |  \- com.vaadin.external.google:android-json:jar:0.0.20131108.vaadin1:test
[INFO]    +- org.springframework:spring-core:jar:5.2.2.RELEASE:compile
[INFO]    |  \- org.springframework:spring-jcl:jar:5.2.2.RELEASE:compile
[INFO]    +- org.springframework:spring-test:jar:5.2.2.RELEASE:test
[INFO]    \- org.xmlunit:xmlunit-core:jar:2.6.3:test

这是我的项目树...这是一个标准的Spring引导结构...控制器在web目录/包下

.
├── java
│   └── com
│       └── neodem
│           └── orl
│               ├── collections
│               ├── config
│               ├── engine
│               │   ├── core
│               │   │   ├── actions
│               │   │   └── model
│               │   └── original
│               │       ├── actions
│               │       └── model
│               ├── service
│               └── web
└── resources

共有3个答案

程和煦

2023-03-14

只是补充一下，我也有同样的问题，并通过将@Controller替换为@RestController来解决。

陶永望

2023-03-14

我在我的情况下找到了解决方案，并发布了一个springdoc git问题（https://github.com/springdoc/springdoc-openapi/issues/378）。它（部分）写道：

定义REST控制器时，spring允许您声明@RequestMapping（value=“/init”），而不使用显式方法，并将接受POST请求。但是，在您的OpenApiResource类中，您调用calculatePath，在那里（第129行）您调用springRequestMappingInfo。getMethodsCondition（）在我的例子中，没有返回任何结果（因为该方法没有在注释中明确定义）。。因此没有请求方法=

如果我显式地定义了方法：@刚需映射（value="/init"，方法=刚需方法。POST）一切都按预期工作。

因此，解决方案是在@RequestMapping

虞祯

2023-03-14

这是因为您使用的是springdoc openapi ui，当您想将springdoc openapi与Swagger ui集成时，它会使用，因此要检查结果，您应该首先添加并启用Swagger ui，然后检查Swagger链接。比如：http://localhost:8080/swagger-用户界面。html。

如果你不想昂首阔步，你必须使用springdoc-openapi-core而不是springdoc-openapi-ui。

总之

解决方案1

添加并启用Swagger UI
检查Swagger Url（{server地址}：{port}/swagger-ui.html.）

解决方案2

将依赖关系从springdoc openapi ui更改为springdoc openapi核心

您的依赖关系必须像下面的代码段：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-core</artifactId>
    <version>1.1.44</version>
</dependency>

解决方案三

按配置列出要包含在文档中的包

#Packages to include
springdoc.packagesToScan=com.neodem.orl.web

这个链接也可能有用。（使用springdoc openapi记录SpringRESTAPI）

类似资料：

python 实现端口扫描工具

本文向大家介绍python 实现端口扫描工具，包括了python 实现端口扫描工具的使用技巧和注意事项，需要的朋友参考一下以上就是python 实现端口扫描工具的详细内容，更多关于python 端口扫描工具的资料请关注呐喊教程其它相关文章！
扫描BLE设备不工作

我试图扫描BLE设备与（我知道它在新版本中已经过时了，但我只是想看看它是否能与我的手机配合使用[4.4]，我正在使用它）。因此，它开始扫描，然后继续，没有给出错误，但没有检测到设备。也会触发OnLEScan事件，但其中的设备参数为null。我的LE设备就在那里并已连接。在Google上，我发现如果BluetoothAdapter没有UUID，就会发生这种情况。如何设置UUID？何时调用/启动O
扫描仪工作不正常

我有一个程序，允许用户输入一个数字的学生数量，他们希望分配一个等级。然后，它打印出哪一个学生在总数中（例如6个中的1个），然后提示用户输入他们的名字和分数。我的分数工作正确，但当最后的消息显示，我不能得到最大名称和第二个最大名称显示任何东西。
Spring Boot组件扫描不工作

我创建了一个示例Spring Boot应用程序，当所有服务类都在一个包中时，该应用程序运行良好，但如果一个服务类引用了不同包中的另一个服务类，那么我将得到BeanCreationException 下面给出了应用程序的代码
Dynamodb AWS Java扫描withLimit不工作

我正在尝试使用Java aws sdk版本1.11.140使用限制为1的DynamoDBScanExpression 即使我使用. with Limit（1）即。返回所有条目的列表，即7。我做错什么了吗？ P. S.我尝试使用cli进行查询返回我只有1个结果。
使用扫描仪时不要循环，因为扫描仪工作不正常

我有一个简单的Do-While循环，它使用的扫描器功能不正常。代码应该显示一个文本，提示用户输入字符串，用户输入字符串，然后程序再次显示相同的文本，并提示用户输入另一个字符串。程序所做的是显示正确的消息，用户输入一个字符串，然后提示用户输入一个字符串，但用户输入之前没有文本。用户输入文本后，它就会正常工作。查看我的代码，我看不出程序有任何理由在不向用户显示文本的情况下提示用户两次输入。

SpringDoc openAPI工具不在Spring Boot Project中扫描API

共有3个答案

相关问答

相关文章

相关阅读

相关工具

相关文档