51工具盒子

依楼听风雨
笑看云卷云舒,淡观潮起潮落

最新发布

Swagger:同一状态码返回不同的 Response 对象
经验分享

Swagger:同一状态码返回不同的 Response 对象

厉飞雨 阅读(2) 评论(0) 赞(2)

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

Swagger 中的 @Operation 和 @ApiResponse 注解
spring

Swagger 中的 @Operation 和 @ApiResponse 注解

厉飞雨 阅读(2) 评论(0) 赞(1)

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

Swagger 记录包含枚举(Enum)参数的文档
spring

Swagger 记录包含枚举(Enum)参数的文档

厉飞雨 阅读(2) 评论(0) 赞(2)

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

在 Swagger 文档中移除 BasicErrorController
开发笔记

在 Swagger 文档中移除 BasicErrorController

厉飞雨 阅读(2) 评论(0) 赞(2)

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

Swagger UI 设置 JWT
软件使用

Swagger UI 设置 JWT

厉飞雨 阅读(3) 评论(0) 赞(2)

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

隐藏 Swagger API 文档中的端点
白嫖帮

隐藏 Swagger API 文档中的端点

厉飞雨 阅读(3) 评论(0) 赞(1)

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

在生产环境中关闭 Swagger-UI
开源工具

在生产环境中关闭 Swagger-UI

厉飞雨 阅读(1) 评论(0) 赞(2)

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

设置 Swagger 文档中的示例和描述
开发笔记

设置 Swagger 文档中的示例和描述

厉飞雨 阅读(1) 评论(0) 赞(2)

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

GIN框架相关博客
开发笔记

GIN框架相关博客

厉飞雨 阅读(2) 评论(0) 赞(2)

[YUAN (yuan316.com)](http://www.yuan316.com/) ![](http://static.51tbox.com/static/2024-08-29/col/c7bda7732d67dade94a79bfdd7271e2d/cb04c496bf074f72a5742cc4565b9be7.png.jpg)

京东多线程编排框架AsyncTool
软件教程

京东多线程编排框架AsyncTool

厉飞雨 阅读(3) 评论(0) 赞(0)

并行框架的使用背景 {#并行框架的使用背景} ---------------------- 经常会有这样的调用场景:app(或web前端)调用后台的一个接口,该接口接到该请求后,需要调用其他多个微服务来获取数据,最终汇总一个最终结果返回给用户。 整如用户请求 我的订单",后台在收到请求后,就需要去调用用户详情RPC、商品详情RPC、库存RPC,优惠券等等很多个服务...