2024-11-21 厉飞雨 阅读(3) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 本文介绍了如何在 API 规范中，为同一个响应定义多个不同的对象，以及如何使用该规范生成 Java 代码和 Swagger 文档。 2、问题陈述 {#2问题陈述} --------------- 定义两个对象（object）。 * `Car` 对象的属性是 `owner` 和 `plate`，两者都是 `String`。 ...

2024-11-21 厉飞雨 阅读(2) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 本文将带你了解 Swagger 中 `@Operation` 和 `@ApiResponse` 注解的主要区别和应用场景。 2、用 Swagger 生成文档 {#2用-swagger-生成文档} ----------------------------------- [Swagger](https://swagger.io/...

2024-11-21 厉飞雨 阅读(3) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 本文将带你了解如何使用 [`swagger-maven-plugin`](https://mvnrepository.com/artifact/io.swagger.core.v3/swagger-maven-plugin) 来在 Swagger 中记录枚举，并在 Swagger 编辑器中验证生成的 JSON 文档。 2、Sw...

2024-11-21 厉飞雨 阅读(2) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 本文将带你了解如何 Swagger 文档界面中隐藏 `BasicErrorController`。 3、问题 {#3问题} ----------- 如果应用中包含了一个 `BasicErrorController`，Swagger 默认会将其所有端点也包含在生成的文档中。 我们需要提供自定义配置来移除不需要的 Contro...

2024-11-21 厉飞雨 阅读(4) 评论(0) 赞(2)

1、简介 {#1简介} ----------- 本文将带你了解如何在 Spring Boot 中配置 Swagger UI，使其在调用 API 时包含 JWT（JSON Web Token）。 2、Maven 依赖 {#2maven-依赖} ----------------------- 本例使用 [`springdoc-openapi-ui`](https://cent...

2024-11-21 厉飞雨 阅读(5) 评论(0) 赞(1)

1、概览 {#1概览} ----------- 在 [Spring Boot](/spring-boot/) 中使用 Swagger 文档时，有时候需要隐藏端点。最常见的情况就是，该端点还在开发中。或者是有一些内部端点，不想暴露给用户。 本文将带你了解如何在 Swagger API 文档中隐藏端点。 2、使用 @ApiIgnore 隐藏端点 {#2使用-apiignore...

2024-11-21 厉飞雨 阅读(2) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 在开发环境下使用 Swagger UI 可以很方便地查看、测试 REST 服务。但是出于安全考虑，在生产环境中往往需要禁用 Swagger UI。 2、Swagger 配置 {#2swagger-配置} --------------------------- 要 [使用 SpringDoc 设置 Swagger](/spri...

2024-11-21 厉飞雨 阅读(2) 评论(0) 赞(2)

1、概览 {#1概览} ----------- 在本教程中，我们将演示如何使用 Swagger 注解使我们的文档更具描述性。我们会学习如何为 API 的不同部分（如方法、参数、响应等）添加描述，以及如何添加请求/响应示例。 2、项目设置 {#2项目设置} --------------- 我们将创建一个简单的 Product API，提供创建和获取 product 的方法。...

2024-11-21 厉飞雨 阅读(4) 评论(0) 赞(1)

构建实时Web应用程序，我们需要考虑如何将数据从服务端发送到客户端，目前有以下几种方法： * 长/短轮询（客户端拉取） * WebSocket（服务端推送） * Server Send Event 服务端发送事件（服务端推送） > 客户端拉取 - 客户端以一定的定期间隔向服务器请求更新； > > 服务端推送 - 服务端主动将更新推送到客户端； 长/短轮询...

2024-11-21 厉飞雨 阅读(6) 评论(0) 赞(1)

1、概览 {#1概览} ----------- [Apache Tomcat](https://tomcat.apache.org/)，简称 Tomcat，是 Jakarta Servlet 规范的开源实现。它作为 Web 服务器接收 HTTP 或 `WebSocket` 请求，并调用负责的 `Servlet` 来处理请求。 本文将带你了解 Tomcat 中的并行部署（Pa...