swagger-ui相关内容
我目前在我的项目中使用 swagger,那里有 100 多个控制器.我猜由于大量的控制器,swagger UI 文档页面需要超过 5 分钟才能加载其控制器.是否可以在 UI 页面上选择特定的控制器并仅为它们加载选项?或者还有其他方法可以更快地加载 UI 页面?帮帮我! 解决方案 您可以在任一控制器上使用 ApiExplorerSettings 来完全忽略控制器或方法. [ApiExplo
..
我想知道是否有任何方法可以让 SpringFox 不显示在调用特定端点时不需要的某个实体的所有字段. 例如: 具有以下实体: 公共类汽车{长身份证;字符串名称;内轮;字符串类型;布尔 canFly;} 以及以下端点: @RequestMapping(method = RequestMethod.GET,产生 = MediaType.APPLICATION_JSON_VALUE)p
..
我习惯于在我的 REST 控制器上添加注释以供 Swagger-UI 使用.但是,我更愿意将 Swagger-UI 指向描述我的 REST 控制器的 YAML 文件.我想要做的一个例子如下所示.(Springfox/Swagger2) DemoApplication.java import org.springframework.boot.SpringApplication;导入 org.
..
我正在开发一个 API,它也会生成 swagger 文档.问题是由于某些原因,请求模型/架构未显示在 swagger UI 中,但我也没有收到任何错误.我需要将映射表示为字符串数组.例如地图[字符串][]字符串.定义对象定义如下. {“定义":{“版本":{“类型":“字符串",“附加属性":{“类型":“数组",“项目": {“类型":“字符串"}}}}} 解决方案 UI 中仍然不支持地图
..
我尝试更改我的 json 文件中的 basePath,这似乎只会更改 swagger-UI 的底部“baseurl".我想摆脱显示为我的 swagger-UI 的组标题的“默认".有没有人能够解决这个问题?我正在使用 Swagger ~2.0. 解决方案 Default 不是路径,而是标签. 在 Swagger 2.0 中,分组是使用标签完成的.每个操作都可以分配给零个或多个标签.在
..
我正在尝试调整自动生成的 Swagger 定义中使用的模型的“displayName". 这只会影响 Swagger 名称,这意味着代码中的命名空间将保持不变,而从 Swagger UI 查看模型时,您会看到自定义名称. 目前,从代码返回的模型名称是一个命名空间,看起来像这样:bcdef,我想向代码添加一个属性并“屏蔽"Swagger 文档的名称,以便在生成文档/Swagger 定义时
..
如何使用 Swagger 2.0 注释定义基本身份验证并使其显示在 swagger UI 中. 在我拥有的资源中: @ApiOperation(value = "返回类别列表", response=Category.class, responseContainer="List", httpMethod="GET", authorizations = {@Authorization(valu
..
我正在使用 Swashbuckle 在我的 WebApi 项目中启用 swagger 和 swagger-ui. 在下图中,您可以看到我的两个控制器显示在 swagger-ui 页面中.这些名称与 C# 代码中的名称相同,但我想知道是否有办法更改此处显示的内容? 这主要是因为如您所见ManagementDashboardWidget 不是用户友好的名称,所以我想将其更改为用户友好.
..
我在我的 .Net Core 2.2 REST 项目之一中使用 Swashbuckle.AspNetCore 5.0.0-rc2.在我的项目中,我提供两个不同的 api,它们在逻辑上相互连接. 今天,我设法将我的 swagger 文档分开,使每个 api 有一个 swagger 端点,仅包含相应的 api 控制器. 我设法通过将指定的组名添加到控制器的 api 资源管理器设置来做到这一
..
想知道如何在 POST 中隐藏 Swagger 中的模型属性.我已经尝试过 Swagger-springmvc (0.9.3) 和 Springfox(支持 swagger spec 2.0),但都无济于事. 问题是我想在通过 Swagger 的 GET 请求中看到这一点.但不是 POST 请求,因为 id 是自动分配的,我只想为 POST 请求隐藏它. 公共类 RestModel {私有
..
我的应用程序中嵌入了 swagger ui.当我在本地运行我的节点应用程序时,UI 运行良好. 但是,当我将 UI 部署到我的“真实"服务器时,我会在 swagger ui 的右下角看到一个错误图像: 我确信这是我正在做的事情,但我不知道.当我通过 http 访问 swagger ui 时,再次在本地工作. 但是,当我部署时,我通过 apache 运行并通过 https 提供服务
..
我正在尝试使用 Swagger 来描述我正在构建的 web-api.问题是我无法理解如何描述复杂的 json 对象? 例如如何描述这个对象: {姓名:“约翰",地址: [{类型:“家",第 1 行:“第一街"},{类型:“办公室",第 1 行:“第二街"}]} 解决方案 好的,根据上面的评论,您需要以下架构: {“定义":{“用户":{“类型":“对象",“必填":[“姓名"],“特
..
我非常喜欢 swagger 记录 Restful API,尤其是“试试看!"按钮,但 swagger-ui 界面看起来不是很酷. 而且我无法相信如此惊人的开源工具没有模板(或者我找不到任何模板)? 我不想要它免费.. 像 http://getbootstrap.com/ 有很多网站可以购买主题(比如 https://wrapbootstrap.com/),为什么我找不到任何 swagg
..
我们在 nginx 代理后面运行服务,以便: http://service-post:8080/swagger-ui.html 路由到公共地址 https://host.com/services/post/swagger-ui.html 或者换一种方式定义: 当 nginx 在 https://host.com/services/post/swagger-ui.html 上收到请
..
我使用 Swagger UI v2.2.0.我有一个返回纯文本的 RESTful 方法.我想用换行符显示此文本. 目前返回的文本包含换行符,但显示为\n.Content-Type 响应头是 text/plain. 我可以返回插入了新行字符(例如,
标签)的其他内容的文本.我也可以更改 Content-Type.我只需要显示文本中的实际换行符. 有没有办法做到这一点?
..
我想访问 https://editor.swagger.io/ 但需要 YAML 文件根据 URL 参数预加载. 所以如果我想查看 https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml,我应该能够将其作为输入提供给可通过互联网访问的 swagger 编辑器. 这可能吗?
..
我可以将 api 密钥表示为标题或 url 末尾的标签,但我需要两者兼而有之.无论如何,这有可能吗?图片已链接这里 解决方案 window.swaggerUi.api.clientAuthorizations.add(swashbuckleConfig.apiKeyName, new SwaggerClient.ApiKeyAuthorization(swashbuckleConfig.a
..
我们当前的部署模式要求我手动编写我的 swagger json 输出,这些输出将由我公司使用的基于 Swagger 的 UI 使用.我希望我正在编写的 json 提供“默认"值来填充所有输入字段的 Swagger UI,包括 body 输入参数.我的 body 参数是一个引用对象,如下所示.我如何定义返回的 swagger JSON 以在单击“尝试此操作"时自动填充请求的正文部分? 在 Sw
..
在我的 API 文档中,我想定义每个 API 端点所需的安全性.该项目已定义角色和权限,以确定哪些用户可以访问 API.Swagger 中记录此信息的最佳方式是什么?是否有关于如何显示此详细信息的最佳做法或建议? 这是我使用 securityDefinitions 和角色自定义变量尝试的,但是当我通过 swagger2markup 或使用 swagger-ui 运行它时,该信息(x-role
..
我在多个微服务上大摇大摆地工作.部署到 Azure 时,由于安全最佳实践,我们需要一起删除 swagger 选项.使用 .net core 2.1寻找定义的例子. 解决方案 首先,什么是“安全最佳实践"?将 API 文档投入生产并没有错.这实际上就是重点:客户应该能够查看文档,以便他们可以正确使用您的 API.如果这些微服务没有公开给外部客户端使用,那么问题就更小了,因为无论如何,外部没有
..