swagger 相关问题

symfony / validator 6.3 和 swagger ，类型数组

初体验symphony，有自定义类FavoriteItemDto 与构造 公共函数 __construct( #[组(["删除"])] #[Assert\NotBlank(groups: ['创建', '

NestJS Swagger 与 Zod 的多部分文件上传问题

我正在开发一个 NestJS 应用程序，并使用 Nestjs-zod 库进行验证和 swagger 文档。但是，在尝试以多部分表单数据请求上传文件时，我遇到了问题...

如何保护.NET 8中的swagger/1.0/swagger.json路由？

我在 ReactJS 应用程序中创建了一个自定义 SwaggerUI (index.html) 文件，可以通过 myapplication.com/docs/swagger/index.html 访问该文件。由于路由经过 /docs/，所以 STS 认证是 ap...

如何让 Swagger 将对象设置为只读

我正在使用 Swagger 和 EF Core，并且正在设置外键。唯一的问题是，当我为 EF Core 设置外键时，Swagger 将 POST 和 PUT 的 UI 设置为包含类 objec...

获取/生成Azure APIm API的swagger url

我在 Azure APIm 中设置了 api，并且各个操作通过各自的 url 进行工作。 我想要这个 API 的 Swagger uri，它具有天蓝色域并列出其中的所有操作。 例如...

Swashbuckle.AspNetCore.SwaggerGen ISchemaGenerator.GenerateSchema 生成一个空架构

我在 .NET 8 服务中使用 Swashbuckle.AspNetCore.Swagger 6.6.2 和自定义 IOperationFilter 来为我的 API 生成请求示例。在我的过滤器中，我试图手动生成一个模式......

向最终用户显示 FastAPI 验证错误

我正在寻找一些库或代码示例，将 FastAPI 验证消息格式化为人类可读的格式。例如。这个端点： @app.get("/") 异步 def hello(名称: str): 返回{“你好”：...

Whitelabel 错误页面 Swagger，此应用程序没有 /error 的显式映射，因此您将其视为后备 swagger2:3.0.0-SNAPSHOT

尝试在 Spring Boot 2.3.1 中配置 swagger。 摇篮配置 存储库{ mavenCentral() maven { url 'http://oss.jfrog.org/artifactory/oss-snapshot-local/' } } 依赖项{

如何将 OCC 扩展中的 API 公开到自定义商务 Web 服务中？

我有自定义商务 Web 服务扩展，名为“mycommercewebservices”，webroot 为“/rest”。现在，我想包含来自商业 OCC 扩展的 API（例如 b2bocc、b2bpunchou...

在 Spring Data Rest 中，如何防止 DELETE HTTP 方法从我的 JpaRepository 导出？

我正在使用 spring-data-rest 并且我有一个像这样的 JpaRepository ： @RepositoryRestResource（路径=“项目”） 公共接口 ProjectsRepository 扩展了 JpaRepository 我正在使用 spring-data-rest 并且我有一个像这样的 JpaRepository： @RepositoryRestResource(path = "projects") public interface ProjectsRepository extends JpaRepository<MetricsProjects, Integer> {...} 我的存储库界面： @RepositoryRestResource(path = "projects") public interface ProjectsRepository extends JpaRepository<MetricsProjects, Integer> { List<MetricsProjects> findByProjectName(String projectName); @Override @RestResource(exported = false) public void deleteById(Integer id); @Override @RestResource(exported = false) public void delete(MetricsProjects entity); @Override @RestResource(exported = false) public void deleteAll(Iterable<? extends MetricsProjects> entities); @Override @RestResource(exported = false) public void deleteAll(); @Override @RestResource(exported = false) public void deleteInBatch(Iterable<MetricsProjects> entities); @Override @RestResource(exported = false) public void deleteAllInBatch(); } 我还添加了disableDefaultExposure()，正如某处建议的那样。 我的配置文件： @Configuration public class SpringDataRestConfiguration implements RepositoryRestConfigurer { @Override public void configureRepositoryRestConfiguration(RepositoryRestConfiguration restConfig) { restConfig.disableDefaultExposure(); } } 但是我仍然看到从 Swagger-UI 中公开的 DELETE 方法，我该如何防止这种情况？ 为 DELETE 端点创建一个控制器方法并返回 405 Method Not Allowed。 为了禁用 Swagger（Springfox 库）中特定端点的显示，我在存储库类中的关联方法上添加了注释 ApiIgnore : @Override @ApiIgnore @RestResource(exported = false) public void deleteById(Integer id); 将configureRepositoryRestConfiguration修改为 @Override public void configureRepositoryRestConfiguration(RepositoryRestConfiguration restConfig) { restConfig.getExposureConfiguration() .forDomainType(put the class type here) .withItemExposure((metadata, httpMethods) -> httpMethods.disable(HttpMethod.DELETE)) .withCollectionExposure((metadata, httpMethods) -> httpMethods.disable(HttpMethod.DELETE)); } 将此处的类类型替换为 className.class，例如，如果 className 是 MetricsProjects，则将 MetricsProjects.class 放在那里。 这是附加信息。

如何使用 SwaggerDocument 设置 swagger 以通过 Bearer Token 传递到端点

我正在使用 Fastendpoint 并尝试使用授权标头设置 swagger，我有以下设置 builder.Services.AddFastendpoints().SwaggerDocument(); 它似乎没有通过持有者...

如何让 Swagger 文档在外部 api 身份验证后面工作？

我们有一个设置，我们的 api 身份验证是通过 AWS Cloudfront 中的第三方库完成的。在我们的 api 中，我们使用第 3 方库 (reitit-swagger) 创建 swagger 文档，因此我们无法更改...

Swagger使用AllOf时无法生成文档

我正在使用 ASP.NET Core 8 Web API 和 Swagger。 当我尝试使用 UseAllOfForInheritance 生成带有 allOf 的代码时，使用以下代码构建 swagger： 生成器.Services.AddSwaggerGen( ...

如何在 ASP.NET Core OData v8 中进行请求标头版本控制

我正在尝试使用 Microsoft.AspNetCore.OData v8.0.1 通过 .NET 5 中的请求标头进行版本控制，并使用 SwaggerUI 进行版本控制。 在 v8 之前，您曾经可以使用 服务。

使用 OpenAPI 时禁用 API 身份验证

我正在使用下面的 spring 和 openAPI 依赖项： org.springframework.boot spring-boot-starter-parent 我正在使用下面的 spring 和 openAPI 依赖项： <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.3.2</version> </parent> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.6.0</version> </dependency> 我的安全配置类定义如下： @Bean public UserDetailsService userDetailsService() { // ensure the passwords are encoded properly UserDetails userDetails = new User(userName, password, Collections.singleton(new SimpleGrantedAuthority("ROLE_" + ROLE))); return new InMemoryUserDetailsManager(userDetails); } @Bean @Primary @ConditionalOnProperty(value = "swagger.auth.enabled", havingValue = "true", matchIfMissing = true) public static BCryptPasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } @Bean public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { String regexPattern; if(swaggerAuthEnabled) { /* Desc: Below regex will hold true for : * - pattern containing health in its resource * - pattern if it not contains * > /actuator/<something> * > /v2/api-docs * > /swagger-ui.html * */ regexPattern = ".*(/health)|^(?!/v2/api-docs|.*/swagger\\-ui\\.html|.*/actuator/).*$"; } else { regexPattern = ".*"; } return http.authorizeHttpRequests(authorize -> authorize.requestMatchers(regexPattern) .permitAll().anyRequest().authenticated()) .httpBasic(Customizer.withDefaults()).build(); } 我添加了类型为：HTTP的SecurityScheme和方案：BASIC 我的目标是通过 swagger UI 添加身份验证，工作正常，但我的所有 API 现在也都落后于身份验证，因此我在通过邮递员或其他服务访问它们时收到 401 错误。 我对 OpenAPI 还很陌生，似乎在浏览有关堆栈溢出的所有其他相关解决方案时迷失了方向。 感谢您的帮助！ 如果我正确理解你的问题，问题是现在每个请求都必须经过身份验证.anyRequest().authenticated()，如果你只想允许任何未经身份验证的请求发送到任何端点，你必须将其更改为.anyRequest().permitAll()

使用 Swagger UI 进行 OAuth 2.0 身份验证

我有一个 ASP.NET Core Web Api 项目，其中包含以下 program.cs 文件： 使用（var范围=临时Provider.CreateScope（）） { var dataverseUtilityService = range.ServiceProvi...

Swagger API 文档：“无法解析参考：针对意外元素评估令牌“路径”时 JSONPointer 评估失败”

我正在开发一个包含 API 的项目。 我目前正在尝试使用 Swagger 记录 API。 我想为我的路由使用外部路径，以避免 yaml 中的行数超过 2000 行。 豪...

Swagger 3.0 - 无法向查询参数添加参数

我有 Node Express 应用程序，并且正在使用 swagger-jsdoc 和 swagger-ui-express 在路由器内部我放置了这段代码： /** * @招摇 * /得到： * 得到： * 标签：[ /api/roba/get ] *总结：

处理文件与 Pydantic 模型中定义的表单数据时出现 FastAPI 错误

由于某种原因，同时处理表单数据和文件上传会引发错误。 从输入导入注释 从 pydantic 导入 BaseModel、StringConstraints、EmailStr 类 RouteBody(BaseMod...

当文件参数包装在模型类中时，NSwag 在 Minimal API 中为 IFromFile 生成不正确的输出

我正在开发一个 .NET 8 Minimal API (Web) 项目，并使用 NSwag 生成 Swagger 文档。我有一个接受文件上传的端点，并且文件参数包装在模型中