swagger-ui 相关问题

Swagger UI是HTML,CSS和JavaScript对象的集合,可以从符合Swagger的API动态生成文档

如何使用 Swagger 描述无名查询参数?

我有一个 API 端点,它使用以下形式的查询参数响应 POST 请求: json_string = '{"物品":%20[{"名称":%20"鸡",%20"数量":%201...

回答 1 投票 0

FastAPI 生成的 API 文档下拉列表用于显示请求正文的多个示例,但仅显示 1 个示例

我正在关注FastAPI教程,特别是有关显示多个示例的部分:https://fastapi.tiangolo.com/tutorial/schema-extra-example/。 我复制了代码: 输入 import Opt...

回答 2 投票 0

在Springfox中自定义Swagger UI的标题和描述

我打算修改标题和描述。 我通过网上搜索发现的方法是使用 ApiInfoBuilder() 构造一个 ApiInfo,然后将其传递给 Docket 对象。 德斯皮...

回答 1 投票 0

如何在示例模式中设置不可为空的 Swagger 响应属性

我试图在 swagger 响应示例架构中将一些属性设置为非空,但我只需在视图模型示例上将属性设置为 [Required] 即可。我知道这不是c...

回答 1 投票 0

Swagger UI 不会在控制器的 GET 操作中呈现复杂类型参数的主体参数字段

我有一个 ASP.NET Web API 2 项目,我已向其中添加了 Swagger - Swashbuckle v5.6.0。一切正常。 Swagger UI 按预期呈现我的 API 的测试端点。 我添加了一个新控制器...

回答 3 投票 0

使用 SwaggerUI 和 nSwag 通过接受标头调用版本化端点

我有一个使用版本化端点的 ASP.NET Core 6.0 Web 应用程序。我选择使用 MediaTypeApiVersionReader,这意味着 api 版本在请求的接受标头中传递。 我是

回答 1 投票 0

IIS 重写,swagger ui 给出 404 未找到错误

我正在使用 Vue js 应用程序托管 Dotnet Core 3.1 项目。为此,我将 vue js 静态文件托管在 www-root 文件夹中。 我的应用程序中还有一个 swagger UI。 这是...

回答 1 投票 0

通过 Swagger UI 看到时如何将 FileUpload 响应正文视为上传按钮

我正在构建一个用于上传文件的 Quarkus REST API,我想在开发过程中使用 Swagger UI,以便在开发网站时拥有紧密的反馈循环。然而我正在努力争取

回答 2 投票 0

为什么 Swagger UI 在 Spring Boot 3.0 版本中不起作用?

我正在尝试运行我的 Spring boot 应用程序,该应用程序基于带有 swagger UI 的 3.0 版本,并且遇到了很多异常我已经探索了许多来源,例如 youtube 和文档,但我不...

回答 3 投票 0

我的招摇占位符描述有问题

我对占位符的描述有疑问,参数看起来重复且独立,如下图所示: 这是我的控制器: 这个控制器链接到一个se...

回答 1 投票 0

自定义 Swagger-UI 布局

Swagger-UI 文档显示了使用 getComponent("operations") 自定义布局的示例。它位于 Swagger-UI 使用的组件列表中。这在 React 中工作得很好。然而,它不会...

回答 1 投票 0

如何使用 OpenAPI 3 Swagger 注释指定列表

对于我的 API,我正在制作一个元注释来处理 Pagable 参数,为此我需要将字符串列表注释为将显示在 Swagger UI 中的参数。 导入 io.swagger.v3.oas.

回答 2 投票 0

.Net Core Web Api 中的 Swagger UI 编码错误

我目前在 .Net Core API 项目中使用 swagger,但 swagger 生成的文档页面存在编码问题: 有谁知道如何解决这个编码问题?我试过看...

回答 1 投票 0

SwaggerUI:显示/隐藏隐藏的架构字段

我正在尝试在项目中设置 OpenApi 文档。目前,我正在记录一个接收 DTO 并返回 DTO 作为响应的端点。 我的实体 DTO 有一个隐藏的私有字段...

回答 1 投票 0

开放 API 生成器为默认响应分配 200 状态代码

我目前正在为我的 API 项目使用 OpenAPI 生成器,但遇到了一个意外问题。当我在 OpenAPI 规范中定义默认响应时,OpenAPI 生成器似乎...

回答 1 投票 0

Swagger UI 对于我们应用程序的每个 API 端点的“示例值”显示为“null”

我对应用程序的后端不太熟悉,但我正在尝试调查为什么我们的所有端点在应用程序的 Swagger 页面上都缺少“示例值”。 我们没有约定...

回答 1 投票 0

找不到 swagger-ui 页面

我的 swagger ui 有问题。我正在使用那些依赖项: org.springframework.boot 我的 swagger ui 有问题。我正在使用这些依赖项: <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>jakarta.xml.bind</groupId> <artifactId>jakarta.xml.bind-api</artifactId> </dependency> <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> <dependency> <groupId>io.jsonwebtoken</groupId> <artifactId>jjwt</artifactId> <version>0.9.1</version> </dependency> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-api</artifactId> <version>2.2.0</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.security</groupId> <artifactId>spring-security-config</artifactId> </dependency> </dependencies> 因此,如您所见,对于 swagger 我正在使用此依赖项 <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-api</artifactId> <version>2.2.0</version> </dependency> 这是我在 application.properties 中的 swagger 设置 # Swagger settings springdoc.swagger-ui.enabled=true springdoc.api-docs.path=/api-docs springdoc.swagger-ui.path=/swagger-ui.html 这是我的 SecurityFilterChain,我认为 Spring Security 可能会阻止我的请求,但看起来不应该 @Bean public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http.cors().and().csrf().disable() .exceptionHandling().authenticationEntryPoint(unauthorizedHandler).and() .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and() .authorizeHttpRequests((requests) -> requests .requestMatchers("/api/auth/**").permitAll() .requestMatchers("/swagger-ui.html").permitAll() .requestMatchers("/api-docs/**").permitAll() .requestMatchers("/api/users/**").hasRole("USER") .requestMatchers("/api/admin/**").hasRole("ADMIN") .anyRequest().permitAll() ); http.authenticationProvider(authenticationProvider()); http.addFilterBefore(authenticationJwtTokenFilter(), UsernamePasswordAuthenticationFilter.class); return http.build(); } 我正在尝试通过此网址找到 swagger ui http://localhost:8080/swagger-ui.html 之后出现Whitelabel错误页面,但是 http://localhost:8080/api-docs 完美运作 那么问题出在哪里呢? 通常,如果您访问/swagger-ui.html,您将重定向到/swagger-ui/index.html,只需再添加一条路径以允许所有: .requestMatchers("/swagger-ui/**").permitAll()

回答 1 投票 0

Azure 函数:自动 OpenAPI 规范中的仅限日期参数

我正在使用 Microsoft.Azure.WebJobs.Extensions.OpenApi 在 .net 6 中创建一个进程内 Azure 函数,以启用自动 OpenAPI/Swagger 规范。 我需要发送一个日期(没有时间)作为...

回答 1 投票 0

创建名称为“org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration$EnableWebMvcConfiguration”的bean时出错

只是学习 Maven 和 Spring Boot 的工作原理,所以我通过做简单的项目进行了一些练习。但我遇到了 swagger-ui.html 的问题,给出了 404 not found 错误。 什...

回答 4 投票 0

如何使用fastapi服务flutter-web项目并集成Swagger?

我正在尝试提供网络应用程序。它是使用 Flutter-web 作为前端构建的,并在 Uvicorn 之上使用 fastapi 作为后端。我还集成了 Swagger API 文档,在本地使用

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.