Swagger是一个框架实现，用于基于Open API规范描述，生成，使用和可视化RESTful Web服务
我正在尝试记录我的项目的 API。 但我在单独的文件中执行此操作 阿奎沃·斯瓦格·坎比奥： 我正在尝试记录我的项目的 API。 但是我在单独的文件中执行此操作 arquivo SwaggerCambio： <?php namespace app\Swagger; use OpenApi\Annotations as OA; /** * @OA\Info( * title="API de Câmbio", * version="1.0.0", * description="API para obter a cotação do dólar em relação ao real." * ) */ /** * @OA\Get( * path="/api/auth/cotacao-dolar", * tags={"Cotação do Dólar"}, * summary="Obter cotação do dólar", * description="Obtém a cotação atual do dólar em relação ao real.", * @OA\Response( * response=200, * description="Cotação do dólar obtida com sucesso", * @OA\JsonContent( * @OA\Property(property="cotacao_dolar_venda", type="string", description="Cotação de venda do dólar"), * @OA\Property(property="valor_em_dolar", type="string", description="Valor em dólar correspondente ao valor em reais fornecido") * ) * ), * @OA\Response( * response=500, * description="Erro ao obter a cotação do dólar" * ) * ) */ 在l5-swagger.php文件中我已经定义了一个注释： 'annotations' => [ base_path('app/swagger'), ],`your text` 我正在等待使用此命令生成文档： php artisan l5-swagger:generate 较新版本的 l5-swagger 使用 swagger-php (> 4.8) 版本，默认情况下不再支持 PHPDoc 注释（显然是因为较新的 PHP 版本支持属性，这使得注释内的注释变得多余）。实际上，这意味着当使用默认选项安装时，l5-swagger无法“查看”您的文档注释注释，因此它将生成像您提到的那样的神秘错误消息。现在您有两个选择： 使用安装doctrine/annotations库 composer require doctrine/annotations 将所有文档注释转换为注释（可能需要更多工作，但更面向未来）。所以代替： /** * @OA\Info( * title="My First API", * version="0.1" * ) */ ...你必须写： #[OA\Info(title: "My First API", version: "0.1")]
Asp.NET Core：OpenAPI 构建时生成的规范文件不包含前缀
我正在尝试使用 OpenApi 在构建时为我的控制器生成规范文件。 我将其包含在 csproj 文件中： $(MSBuildProjectDirectory)/ApiSpecs...
如何添加生成的 openapi typescript-Angular 客户端的访问令牌
我正在进行以下设置... 后端：为我的 Angular 客户端提供带有 OpenAPI 代码生成的 Spring Boot 前端：角度 我可以将生成的代码导入到我的项目中，并且我可以轻松地使用 m...
问题就在这里。我正在使用 utoipa 生成文档。我想按组划分路线。例如，在 axum 中我们可以做这样的事情，它会工作得很好： //main.rs 路由器::n...
Swagger 显示“无法获取”错误，但在 Postman（API 网关）中工作正常
我是 Swagger 新手。我创建了一个 aws API 网关。当我尝试使用 swagger 运行它时，出现此错误 获取失败。 可能的原因： 跨域资源共享 网络故障 URL 方案必须是“http&qu...
修改 NestJS 中 OpenAPI (Swagger) 架构中出现的 DTO 名称
我面临一个问题，我的 DTO 类型被命名为一件事，但我希望它们在 OpenAPI 文档页面中以不同的名称出现。 例如，我有一个在我的控件中使用的 UserDto 类...
在 Spring 中托管手动制作的 openapi.yaml 规范的最佳方式
环顾四周寻找这个答案，我只找到了如何从代码生成和托管 openapi 规范，而不是相反。 我们创建了一个 .yaml 文件，其中包含我们所有的 api 规范....
Swagger ui 不加载函数http触发器和nestjs
我正在尝试为我的azure http触发功能配置swagger，但是当我在浏览器中查询定义swagger的路径时，一些请求处于待处理状态，如下图所示。我...
在 POST 中使用 JAX-RS `@DefaultValue` 作为 bean 属性
我有以下 JAX-RS 资源： @邮政 公共响应createPerson（最终用户用户）{ // ... } 用户 bean 是： 公共类用户{ 受保护的字符串姓氏； 受保护的字符串 r...
在我的 Net 6 Web-API 项目中，我使用 OData 和 Swagger（它是在创建项目时自动添加的）。 它开箱即用，但 Swagger 生成的某些 URL 存在问题。 他...
我想通过dynamoDB创建表User，并具有一些由swagger设计的属性： 用户{ id（字符串，可选）：用户的UUID， 名称（字符串，可选）， lastLoginedAt（字符串，可选），...
如下图所示，即使开放 API 中存在最大长度和最小长度，Azure APIM 的开发人员门户中的请求也只能看到四列......
为了学习 Auth0，我克隆了他们的示例词汇表项目并将其升级到 net8 net8.0 为了学习 Auth0，我克隆了他们的示例 glossary 项目并将其升级到 net8 <Project Sdk="Microsoft.NET.Sdk.Web"> <PropertyGroup> <TargetFramework>net8.0</TargetFramework> <UseAppHost>false</UseAppHost> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.11" /> <PackageReference Include="Swashbuckle.AspNetCore" Version="7.1.0" /> </ItemGroup> </Project> 我还添加了一个.sln 当我跑步时，我看到了 swagger ui 我在 Auth0 中设置了 api，并使用应用程序来使用它。 该应用程序已检查权限。 在我已经放入的应用程序设置中 "Auth0": { "Domain": "myoauthtenant.au.auth0.com", "Audience": "https://glossary.com", "ClientId": "GS9.. etc", "ClientSecret": "BYl2.. etc" } 我尝试使用 OAuth0 api 中的“测试”选项卡和 OAuth0 应用程序中的“测试”选项卡创建令牌 我还在 GitHub 上提出了我的问题。 我的 API 在我的测试应用程序中获得了授权 我从“测试应用程序快速启动”选项卡复制不记名令牌并将其粘贴到 Swagger 授权输入中 然后尝试发布 授权文件在这里。 据我所知，该项目也应该在 .NET 8 中运行。 恐怕您正在混合配置 API 和 OAuth 客户端应用程序的说明。例如，您不需要 ClientId 中的 ClientSecret 和 appsettings.json 来配置 API。 按照本文中的说明测试 API（顺便说一下，这是该示例项目附带的文章）
虽然这里对这个主题有很长的讨论：https://github.com/swagger-api/swagger-ui/issues/156 我还没有找到一种更干净的方法来“有选择地”禁用“试用”按钮。 我想要
如何在 Dotnet API 中接收 Enum 作为字符串？
我有一个用 swagger 记录的 dotnet API 应用程序。在我的一个端点中，我收到如下 DTO： 公共类 CreateCooperativeUserDTO { [必需的] 公共必需字符串名称 {...
如何在 Spring Boot 3.4 项目中实现 swagger ui [已关闭]
过去两年我使用 Springfox 开发 Spring Boot 应用程序。 Springfox 为您的 REST API 生成文档和测试 ui。 但实际上 Springfox 项目已经死了并且不支持
在 Spring Boot 3 中的 Swagger 3.0 中配置 Jwt 令牌
我正在使用 Spring Boot v3.0.2 应用程序作为我的后端，并且我正在尝试将 Swagger v3.0 与我的应用程序集成以用于 api 文档目的。我已经成功配置了 swa...
我正在构建一组 API 和 Webhook。对于常用的 API，我可以毫无问题地编写 YAML 文件来在 Swagger 中记录它。不过，我还想记录一下 webhook，例如它们的 r...
为什么 springdoc-openapi 在按照开箱即用的描述组装时不会返回 api 文档？
当我尝试在一个有很多移动部件的应用程序中从 springdoc 检索 api-docs 时，我遇到了错误 404。为了调试问题，我构建了一个简单的 springboot 应用程序，其中只有......
如何在Spring boot中同时使用@RestControllerAdvice和Swagger UI
我有一个非常简单的 Spring boot 项目，包含 Swagger UI： org.springdoc springdoc-openapi-starter-webmvc-ui 我有一个非常简单的 Spring boot 项目，包含 Swagger UI： <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.5.0</version> </dependency> 在我设置一个类有@RestControllerAdvice之后，尝试查看 swagger UI 会抛出异常： 日志是 java.lang.NoSuchMethodError: 'void org.springframework.web.method.ControllerAdviceBean.<init>(java.lang.Object)' 树： └───com └───cuong02n └───test │ App.java │ ├───controller │ CourseController.java │ StudentController.java │ └───exception CustomExceptionHandler.java <-- The @RestControllerAdvice here StudentException.java 阅读并通过添加 basePackage 尝试一些解决方案后，我仍然无法访问 Swagger UI。 更新 pom.xml is： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.4.0</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.cuong02n</groupId> <artifactId>test-controller-advice-swagger</artifactId> <version>0.0.1-SNAPSHOT</version> <name>test-controller-advice-swagger</name> <description>test-controller-advice-swagger</description> <properties> <java.version>17</java.version> </properties> <dependencies> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> 根据@M.Deinum，这是由于不兼容而导致的，我正在使用 spring-boot-starter-parent 3.4.0 和 springdoc-openapi-starter-webmvc-ui 2.5.0。他们很矛盾。 我的解决方案是将 spring 降级到 3.3.5，效果很好。