Swagger使用Spring的注解
Swagger是一种用于构建、文档化和测试RESTful API的开源框架。它提供了一组注解，可以与Spring框架集成，使开发人员能够轻松地创建和管理API文档。
Swagger的主要特点包括：
- API文档自动生成：通过使用Swagger注解，开发人员可以将API的详细信息（如请求和响应的数据类型、参数、路径等）直接添加到代码中。Swagger会自动解析这些注解，并生成可读性强的API文档。
- 可视化API文档：Swagger提供了一个用户友好的界面，用于展示API文档。开发人员可以通过浏览器访问该界面，查看API的详细信息、测试API的功能，并获取示例请求和响应。
- API测试工具：Swagger界面不仅可以用于查看API文档，还可以用于测试API的功能。开发人员可以直接在界面上输入请求参数，发送请求，并查看响应结果。
- 与Spring集成：Swagger可以与Spring框架无缝集成，通过添加Swagger注解，开发人员可以轻松地将API文档与Spring应用程序的代码保持同步。
Swagger的应用场景包括但不限于：
- API文档生成：Swagger可以帮助开发人员自动生成API文档，减少手动编写文档的工作量。
- API测试：Swagger提供了一个方便的界面，用于测试API的功能，开发人员可以在不使用其他工具的情况下进行API测试。
- API文档展示：Swagger的可视化界面可以用于展示API的详细信息，方便其他开发人员查阅和理解API的功能。
腾讯云提供了一款与Swagger相关的产品，即API网关。API网关是一种用于管理和发布API的服务，可以与Swagger集成，实现API的自动化文档生成和管理。您可以通过访问腾讯云的API网关产品介绍页面（https://cloud.tencent.com/product/apigateway）了解更多信息。
相关·内容
在spring框架中，常见的模式似乎是从控制器注释生成swagger文档。我们的swagger.yaml文件正在对传入的请求运行我们的验证，所以我们希望呈现来自资源文件夹中的yaml文件的swagger文档；我们希望避免在我们的控制器中有太多的注释。有没有办法在Spring中做到这一点？
浏览 26提问于2020-01-04得票数 0
2回答
我正在用Apache CXF构建Spring Boot应用程序。当尝试添加swagger时，我得到没有在规范中定义的操作！错误，尽管我通过注释1-2操作指定。Swagger的CXF配置部分如下：
factory.setFeatures(Collections.singletonList(createSwaggerFeature()));
public Swagger2Feature createSwaggerFeature() {
Swagger2Feature swagger2Feature = new Swagger2Feature();
swagger2
浏览 2提问于2017-10-01得票数 0
可以将spring-auto-restdocs与Swagger/SpringFox，swagger2markup一起使用吗？
我想：-使用Swagger/SpringFox提供测试区域，但我希望该UI中的示例类似于- spring-restdoc提供示例代码片段，并-使用spring-auto-restdocs从POJO获取表示JSON对象的文档，只需将Javadoc添加到字段，而不是swagger注释
浏览 7提问于2018-05-29得票数 1
3回答
外面有春狐的替代品吗？
、、、
过去两年，我在Springfox开发Springfox应用程序。Springfox为REST生成文档和测试ui。太棒了。
但实际上Springfox项目已经死了，不支持最新的Spring。我有三个问题
还有其他直接生成Swagger的方法吗？还有其他图书馆/项目吗？
如何在Spring项目中实现swagger？
浏览 8提问于2019-11-20得票数 27
回答已采纳
1回答
我正在遵循上给定的文档
以下是我在我的项目中编写的源代码，具有本文中提到的类似依赖项。
注释定义：
package com.sell.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RU
浏览 11提问于2018-01-31得票数 3
我有一个Spring Boot，它接受RESTful作为POST操作的请求体。JSON是使用Jackson ObjectMapper转换成特定对象的。随着越来越多的团队使用我们的API，我们需要有好的文档是最新的。我把Swagger和Spring REST Docs看作是记录API的方法。然而，我还没有看到一个对我的情况有帮助的例子。
我有很多POJO，它们都是从一个普通的POJO继承而来的，有些还有很多继承链。存在许多不同的POJO，每个POJO代表一个不同的事件。POJO有像@NotNull这样的注解和其他ObjectMapper注解来描述JSON。我们希望通过代码来记录这些POJO或模型
浏览 0提问于2016-04-28得票数 0
1回答
我使用Springboot + Springfox + Spring Data Rest来生成我的API和文档。
它工作得很好，除了在SDR中，你可以通过编程删除一个REST方法，比如一个特定实体的"PUT“。
ExposureConfiguration config = restConfig.getExposureConfiguration();
config.forDomainType(User.class).disablePutForCreation();
config.withItemExposure((metadata, httpMetho
浏览 18提问于2019-11-27得票数 0
是否可以为不遵循基于REST的服务的遗留Java应用程序生成swagger定义？注意:我能够使用REST JAXRS和其他一些框架(如spring )为应用程序生成swagger。因此，有可能为不使用任何注释的应用程序生成。例如，只使用html、jsp、servlets等开发的web应用程序。在某些地方，我看到swagger是专门用于REST服务的，但我只是想确保有一种方法可以用于遗留应用程序。
浏览 4提问于2017-11-17得票数 0
我在一个项目中工作，我们用Swagger记录了我们后端的API。我想为Swagger使用基于注释的配置。对于使用@Tag、@Operation和@ApiResponses的控制器类，可以使用以下语句导入它们： import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.
浏览 412提问于2021-10-13得票数 1
回答已采纳
1回答
我正在使用Spring进行REST API开发。我有一些有很多端点的API。当我打开swagger ui时，它看起来像是打包的。
我刚刚读了的文章，看到我们可以根据资源级别对端点进行分组。
我只想知道如何使用Spring的swagger注解来实现这一点。如果有人能举个例子来描述，我将不胜感激。
我还想知道我们是否可以重新组织(更高级别的分组)，我们用上面的方式推导出的组？
浏览 1提问于2018-05-28得票数 9
回答已采纳
我正在尝试通过gradle插件测试openapi代码生成器。所以，我有一个包含文档的.yml文件(在中运行它，看起来很酷)
openapi: 3.0.2
info:
title: Testing docs
version: 1.0.0
tags:
- name: Registration
paths:
/registration:
post:
tags:
- Registration
summary: Register user
...
这是我的build.gradle的一部分
plugins {
id "org.
浏览 18提问于2021-02-19得票数 0
回答已采纳
我正在Spring Boot中构建一个RESTful应用程序，我想在POST方法的请求体中强制使用一些属性。
在swagger yaml中，我将它们标记为必需的"true"，但当我使用swagger编辑器生成类时，我看不到任何影响，即我甚至看不到@NotNull注释或任何类似的东西。
如何在我的java模型类中将它们标记为强制的？@NotNull是要走的路吗？
如果是，我应该在我的请求主体类中执行，还是在jpa文档类中执行，或者两者都执行？
谢谢！
浏览 13提问于2020-06-04得票数 1
回答已采纳
我有一个Spring Boot应用程序，它使用springdoc-openapi-ui来记录REST端点。此外，Spring MVC还提供了一些简单的UI。出于某种原因，在Swagger UI中，我不仅看到了REST的模式，还看到了ModelAndView类的模式。有没有办法把它从那里移走？
我已经尝试了一些选项，比如限制包使用springdoc.packagesToScan或springdoc.model-and-view-allowed进行扫描，但没有任何结果？
浏览 0提问于2020-10-11得票数 1
你们中有人能为基于Spring的REST实现Swagger提供任何替代方案吗？这不是春靴。我试过Springfox，但是IMHO这是一堆乱七八糟的东西。
浏览 6提问于2017-05-04得票数 9
回答已采纳
我有一个使用spring (4.0.1版) REST构建的web服务应用程序。我为不同的资源创建了不同的项目，比如A&B和一个通用的动态web项目C。我使用gradle作为构建工具。项目A和B在项目C中定义为依赖项。我为REST API文档集成了swagger-springmvc:0.8.5。我正在使用基于Java的spring配置，我的spring和swagger配置文件是项目C的一部分。
当我仅在项目C中添加swagger-springmvc依赖项时，它在eclipse中构建并正常工作(我通过eclipse运行tomcat )。我可以查看项目A& B中所有资源的REST A
浏览 1提问于2014-07-31得票数 0
1回答
我使用的是Spring Swagger库v1.0.2
Maven：
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
我可以扫描我的REST API并在Swagger UI上查看它。我甚至实现了OAuth，它工作得很好。
然而，有一个功能我需要实现。我想隐藏一些RES
浏览 0提问于2015-09-17得票数 9
回答已采纳
有没有人可以分享一下将现有spring应用程序转换为Quarkus的经验
现有的spring应用程序依赖于1) Swagger 2) Oracle Jdbc驱动程序3)日志记录框架4) Spring自动连接
浏览 0提问于2019-05-02得票数 0
有没有办法将Spring Boot应用程序配置为(例如，通过gradle任务)生成一个带有rest客户端的jar文件？
我听说过Swagger和像springdoc、springfox这样的库，但它们会在应用程序启动时生成web api。我想通过CI/CD管理rest api客户端来自动化Kubernetes集群内微服务之间的通信过程，而不是手动工作。
浏览 7提问于2021-12-01得票数 0
我使用swagger-maven-plugin(kongchen)来生成静态文档，我想像这样生成yaml： swagger: "2.0"
info:
version: "1.0.0"
title: "Swagger example"
paths:
/api/students:
post:
operationId: "addStudent"
parameters:
- in: "body"
name: "body"
浏览 48提问于2020-09-21得票数 1
我是web服务的新手。出于示例目的，我创建了一个简单的服务，每当我启动服务器时，我都会收到以下错误。请任何人帮助我摆脱这个错误。 已有一个终结点在/voterRestService上运行 Voter.java package com.swagger.model;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name="Voter")
public class Voter
{
private long id;
private String name;
pu
浏览 27提问于2019-02-14得票数 0
回答已采纳
我目前正在使用Swagger在前端(angular)生成服务。这个服务允许我调用我的Spring Boot Rest API。 Spring Boot中的示例： @PostMapping(value = "/", headers = {"ROLE-ORIGIN=ADMIN"})
public StatusDTO saveUser(@RequestBody AdminDTO dto)
@PostMapping(value = "/", headers = {"ROLE-ORIGIN=PUBLIC"})
public Status
浏览 20提问于2019-03-19得票数 0
回答已采纳
1回答
Swagger注解是否可以与enunciate和maven一起使用。我正在尝试添加swagger注解，但它不起作用，取而代之的是默认的java文档注释。
尝试向enunciate.xml的swagger标签添加参数，如扫描或resourcePackage，该标签存在于Swagger BaseConfig类中，但看起来不支持这些参数。
pom中定义的依赖关系：
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
&
浏览 11提问于2019-04-24得票数 0
在laravel 6中首次安装Swagger。。
composer require "darkaonline/l5-swagger"
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
在生成命令时
php artisan l5-swagger:generate
得到类似以下的错误：
php artisan l5-swagger:generate
Regenerating docs
ErrorException : Required @OA\Info()
浏览 17提问于2019-10-18得票数 0
我必须将spring-cloud项目迁移到Kubernetes部署。这将意味着删除对网关、配置服务器、发现服务器等的依赖。然而，我想保留的一部分是spring-cloud open feign提供的声明性REST客户端，这样我就可以避免为服务间通信编写客户端实现。 我想出的解决方案看起来像这样： @FeignClient(name = "useless", url = "http://${product.service.url:localhost:3333}")
public interface ProductApiFeign extends ProductA
浏览 10提问于2020-04-10得票数 0
回答已采纳
我正在尝试连接到远程地图集银行，但是看起来我被重定向到了本地主机。我像往常一样配置了spring.data.mongodb.uri，几天前相同的项目还在工作，其他具有相同结构的项目也在正常工作。使用相同的连接uri，我可以通过mongoDB客户端进行连接。我使用的是spring boot 2.6，下面是通过gradle使用的依赖项 compile group: 'com.google.code.gson', name: 'gson', version: '2.8.6'
compile group: 'net.source
浏览 25提问于2020-06-29得票数 0
回答已采纳
4回答
是否有一种不使用@Value注释就可以在春季从外部属性文件中读取文本的方法。例: application.properties
var.foo="hello"
我可以将它注入spring中
@Value("${var.foo}") String value;
作为类变量。是否有一种不使用@Value注释来包含此属性的方法。类似于JSR验证的方式。
@NotNull(message={custom.notnull})
并在ValidationMessages.properties文件中将此属性值外部化。
例如，如果我有一个资源(web组件)类，如果我必须使用Swa
浏览 4提问于2016-08-23得票数 11
回答已采纳
有一个Spring MVC应用程序，客户可以选择下订单。您可以在订单中设置订单的日期和时间。我根本没有frontend，所以我通过swagger测试方法。当我在swagger字段中输入日期时，默认情况下，2020-03-11 09:25:00.000000会返回一个json错误，并且在应用程序控制台中，它会发出警告。该怎么办呢。请帮我解决这个问题。
JSON：
{
"timestamp": "2020-05-21T07:57:50.511+0000",
"status": 400,
"error": "Bad
浏览 74提问于2020-05-21得票数 1
回答已采纳
我有一个用Spring制作的rest api，正在使用Swagger编写文档。最近实现了一种基于令牌的身份验证。在令牌中，有(内部)用户的角色(权限)。每个控制器都使用几个Swagger注解和如下所示的@PreAuthorize(some roles..)进行注释：
@ApiOperation("Delete user")
@ApiResponses(value = {
@ApiResponse(code = 404, message = "User not found", response = ErrorResponse.class)
})
@
浏览 13提问于2017-04-20得票数 11
5回答
我尝试实现Spring Condition org.springframework.context.annotation.Condition，如下所示：
public class APIScanningDecisionMaker implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// Not able to read the property "swagger.scanner.can
浏览 0提问于2015-09-26得票数 12
1回答
我有一个用于POST操作的夸张的Spring MVC端点。该操作接受一个路径参数和一个(json)请求实体。生成swagger UI时，它会自动创建请求正文数据类型的示例值。此示例基于应用程序中的java实体。实体用于其他一些操作，但是对于POST操作，我不希望在示例中公开一些实体字段。有没有可能在不修改现有java模型的情况下修改这个示例？例如，是否可以在下面的示例中排除lastUpdate。
浏览 10提问于2017-02-28得票数 4
2回答
Swagger ui -查询参数
、、、、
我正在使用Swagger ui和Swagger core (1.3)来开发jersey应用程序。我有一些查询参数，我必须发送与每个请求，如post，get，delete…
我怎么能默认这一点？
浏览 23提问于2015-07-02得票数 10
在我的Springdoc生成的OpenAPI规范中，我得到了验证错误，并且在网上找不到与我的Java代码的构成方式相匹配的示例。
我正在尝试用Springdoc为Spring Boot控制器生成一个OpenAPI规范。我有一个具有多个路径变量的路径的映射，方法签名接受一个命令对象(命令对象是从这些路径变量自动构造的)。Swagger-UI.html似乎或多或少可以工作，但生成的JSON/YAML规范似乎无效。
我指的是代码片段：
@GetMapping("/myPath/{foo}/{bar}/{baz}")
public Mono<MyServiceResponse&g
浏览 5提问于2021-02-05得票数 0
我正在使用一个swagger生成的服务器(从editor.swagger.io导出)来测试apiDiscovery-1.0特性。pom.xml文件包括
<swagger-core-version>1.5.9</swagger-core-version>
如果我推送生成的war而不指定server.xml文件，只指定应用程序的war，则可以访问
如果我使用包含server.xml的
<feature>apiDiscovery-1.0</feature>
在这种情况下，当指向时，我会得到以下异常
2016-09-21T00:34:15.05+0200
浏览 2提问于2016-09-21得票数 0
我正在使用Swagger来记录我的project.And，我想从springdoc生成YAML文档。但是当我生成这个YAML文档时，YAML没有我的Swagger文档注释。例如。我的项目中有一个端点： @ApiOperation(value = "Return a list of Pix Wallets.", httpMethod = "POST", response = DResponse.class)
@PostMapping("/digital-wallet")
public ResponseEntity<DResponse>
浏览 54提问于2020-10-24得票数 0
我已经实现了一个Jax-RS资源(使用Dropwizard)，其中包含以下方法：
import javax.ws.rs.DefaultValue;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.QueryParam;
import org.hibernate.validator.constraints.NotEmpty;
[...]
@POST
@Timed
public Prediction predict(
@QueryParam("content")
浏览 21提问于2018-09-07得票数 1
回答已采纳
在Swagger model / Example value中，我看到了$date-time字段的样本值。
"lastModifiedDate": "2020-07-09T12:50:48.461Z"
但是我已经这样定义了这个字段
@JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", timezone="America/New_York")
private Date lastModifiedDate;
因此，我的API返回的实际值如下所示：
"
浏览 0提问于2020-07-09得票数 0
我们将应用程序部署为EAR，该EAR包含多个具有不同上下文路径的WAR文件。
我们已经在jboss中添加了swagger作为模块，并将其用作EAR中的依赖项。
swagger是否支持EAR中的文档？是否有任何文档或链接指向与EAR集成的指南？
浏览 0提问于2016-09-19得票数 0
我用的是Jackson和spring boot。我需要根据控制器显示/隐藏来自相同响应/请求模型的字段。例如，对于controllerA，我需要显示字段，而对于controllerB，我需要隐藏它。在两个控制器中使用的模型是相同的。我尝试过@JsonView，但它给出了Swagger文档的问题。请帮帮忙
浏览 73提问于2020-10-24得票数 0
我使用gin-swagger来生成API文档。 默认情况下，它在页面列表的底部显示Models。 ? 如何隐藏？
浏览 56提问于2021-01-29得票数 0
我正在将Springfox2.2.2集成到我的Spring MVC项目中，但是没有生成我认为应该生成的api-docs。下面是关于我的配置的一些信息。
我提供了以下依赖项(以及其他库，如fasterxml、webjars、spring的正确版本等)。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
&l
浏览 2提问于2015-11-18得票数 2
我用Spring MVC实现了简单的REST服务。我决定用Springfox和Swagger 2.0来描述它们。在我开始添加安全模式和上下文之前，一切似乎都很正常。我对某些端点使用HTTP基本身份验证，对其他端点使用基于令牌的身份验证。无论我做什么，我都看不到任何选项来设置HTTP基本身份验证凭据或在Swagger UI中指定令牌。下面是我的配置。为了简单起见，我将这两种模式都应用于这里的所有端点。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket apiV1() {
浏览 0提问于2016-04-25得票数 9
新手问题:我必须用Swagger 2.0中的一些客户端重新构建一个旧的REST API。不幸的是，一些API调用以如下方式用于HTTP post :对于内容，它使用POST主体，但对于"sitekey“，它使用URL参数。所以每个帖子看起来都是这样的：
POST api/update?sitekey=xxx HTTP/1.1
....
{"json": "content"}
我不能忽略sitekey，那么我如何在swagger中对这样的东西建模呢？
浏览 3提问于2017-03-06得票数 0
回答已采纳
我在我的Spring Boot应用程序中使用Springfox Swagger2版本2.4.0、Springfox Swagger UI版本2.4.0和Swagger Annotation版本1.5.0。
这里的问题是，我能够为我的控制器的API生成swagger UI，并且能够对其进行测试。但我无法为我的请求标头指定请求标头描述。我使用@RequestHeader注解来做同样的事情。
我的控制器API中的代码片段如下：
@RequestHeader(name = "Api-Key") String apiKey
请求头的Swagger UI如下所示：
图像中突出显
浏览 4提问于2017-02-20得票数 9
我有一个界面 public interface WebExportable {
@RequestMapping("/export")
Object export();
} SpringFox是否支持仅使用接口生成Swagger Spec？
浏览 21提问于2019-04-13得票数 2
我有这个代码。 @RequestMapping(value = "/search/",
method = RequestMethod.GET,
produces = org.springframework.http.MediaType.APPLICATION_JSON_VALUE)
@ApiOperation(value = "Search for a Device",
response = DeviceSummary.class,
position = 0)
List<DeviceSummar
浏览 13提问于2019-01-17得票数 0
回答已采纳
1回答
我想用Swagger和Spring来记录REST，
我发现Spring3只能使用Swagger V1
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
当我在@RequestBody前面添加@ApiParam时，不要在Data中完全显示。
最后，我选择了Spring 4中的Swagger V2
我添加了一些依赖项和更改，如下所示。
<artifactId>springfox-swagger2</a
浏览 1提问于2015-11-04得票数 0
回答已采纳
我有一个现有的Spring，我想为它生成OpenAPI 3.0 YAML文件，而不是Swagger2.0JSON/YAML？
因为到目前为止，SpringFox不支持YAML生成。它使用Swagger2.0(遵循OpenAPI3.0规范)生成JSON。
此外，还有，但它似乎不支持Spring。
我尝试了孔晨spring plugin，它能够生成YAML文件，但使用Swagger2.0定义，而不是打开API3.0，如下所示：
swagger: "2.0"
info:
description: "Test rest project"
version:
浏览 0提问于2019-02-28得票数 26
回答已采纳
2回答
我使用Swashbuckle和Swagger自动生成API文档。
My端点使用以下PersonViewmodel：
public int? ID { get; set; }
public string Name { get; set; }
我的端点方法以PersonViewmodel作为主体，并使用IActionResult返回一个PersonViewmodel。但是，我不希望用户定义一个ID，因为它是由业务逻辑生成的。在代码中，如果设置了ID，则忽略该ID。
如何更改Swagger以不显示主体输入的示例值中的ID，但仍然显示响应的示例值的ID？
我发现了许多方法可以从Swagger中完全删除
浏览 6提问于2021-10-21得票数 0
我有一个现有的项目，具有Rest Web服务的java代码。我将Swagger集成到java项目中，这反过来又添加了很多注释和描述，弄乱了我现有的代码。有没有一种方法可以集成swagger并从另一个类读取值，而不是弄乱我现有的类？
浏览 2提问于2016-12-14得票数 1
当注解为：@Component、@Service或@Repository (Spring注解)的类工作正常并调用afterPropertiesSet()方法时，如果我有一个注解为@Named - CDI注解的类，则afterPropertiesSet()方法永远不会被调用。Spring不应该提供对CDI注解的完全支持吗？所有的依赖注入在@Inject中都工作得很好，只是InitializingBean不起作用。有没有人能解释一下是这样的？
浏览 2提问于2013-06-24得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
