草庐IT

$swagger

全部标签

node.js - Rest API的swagger和loopback之间的区别

Swagger有助于创建RestfulApi,我明白了。你会在哪里使用LoopBack,这是另一个创建Restapi的工具吗?LoopBack支持swagger2.0。我在这里很困惑,它们可以互换使用。 最佳答案 Swagger是一个文档框架。如果您将适当的注释附加到您的代码中,它会生成一个“实时”文档站点,让用户能够以可视方式查看您的所有REST服务,包括他们的请求和响应格式,并能够执行示例调用。Loopback是一个框架,可帮助您自己编写REST服务。 关于node.js-RestA

node.js - 我应该如何将 Swagger 与 Hapi 一起使用?

我有一个正常工作的普通Hapi应用程序,我计划迁移到Swagger。我安装了swagger-node使用官方说明,并选择Hapi执行“Swagger项目创建”时。但是,我现在很困惑,因为似乎有几个用于集成swagger-node和hapi的库:hapi-swagger:最受欢迎的一个hapi-swaggered:有点受欢迎swagger-hapi:不受欢迎且不那么活跃,但被官方SwaggerNode.js库(即swagger-node)用作Hapi项目的默认设置虽然swagger-hapi是“官方”方法,但我试图找到有关如何在Hapi路由上进行各种配置的信息(例如授权、范围等)。这些方

node.js - 为现有的 NodeJS 服务器生成 Swagger 文档

根据Swaggerwebsite,有两种方法:自下而上和自上而下。我有一个想要在Azure环境中部署的现有NodeJS服务器,它需要一个Swagger文档(APIAPP)。有人知道使用代码生成Swagger的工具吗?如果你能指出一个教程就更好了。没找到。 最佳答案 问题有点老了,但仍然存在。只需像这样嵌入分析中间件,就可以完全自动生成Swagger(OpenAPI)规范:https://github.com/mpashkovskiy/express-oas-generatorconstexpress=require('express

node.js - Swagger 可以根据现有的快速路由自动生成其 yaml 吗?

我继承了一个现有的API,我想Swagger记录它,但我还不知道它的全部范围。Swagger(或其他中间件/工具)能否根据现有的快速路由自动生成yaml(用于swagger)?对于我在其他问题上看到的情况,这似乎主要是一项手动工作,但我正在仔细检查这里是否有人找到解决此问题的方法。 最佳答案 我在自动生成Swaggerjson和为我帮助构建的API手动编写它方面都有经验。根据我的经验,这是两者的优缺点。Swagger自动文档生成:我们将swagger-node-express模块与swagger-ui结合使用。https://www

json - Swagger 在 Docker Image 中使用本地 json 文件运行

所以,我想针对LocalJson运行localSwaggerUI。为此,我遵循可用的说明here:这是该文档中共享的命令:dockerrun-p8081:8080-eSWAGGER_JSON=/foo/swagger.json-v/bar:/fooswaggerapi/swagger-ui这里我理解-p选项,但是这个-e和-v令人困惑。所以我们假设我在我的Mac桌面上保存了一个JSON文件,其路径是:/Users/abc/Desktop/lp.json因此对于此文件,命令将更改为:dockerrun-p8081:8080-eSWAGGER_JSON=/Users/abc/Desktop

ruby - 如何使用公共(public) swagger-generator docker 镜像生成客户端?

我们有一个完全docker化的Web应用程序,其中包含API的有效Swagger定义。API在其自己的docker容器中运行,我们使用docker-compose来编排所有内容。我想根据位于http://api:8443/apidocs.json的Swagger定义生成一个Ruby客户端。我已经翻阅了文档here,这导致我到Swagger'spublicdockerimage用于生成客户端和服务器代码。遗憾的是缺少文档,并且没有提供实际使用docker镜像生成客户端的示例。Dockerfile表示其容器运行Web服务,我只能假设它是http://generator.swagger.io

docker - 如何使用本地代码更改和我自己的 swagger.json 运行 swagger-ui?

https://github.com/swagger-api/swagger-ui上的自述文件指定Swagger-UI可以像这样使用您自己的文件运行dockerrun-p80:8080-eSWAGGER_JSON=/foo/swagger.json-v/bar:/fooswaggerapi/swagger-ui如果我把它翻译成这样的话我会用dockerbuild.-tswagger-ui-local&&\dockerrun-p80:8080-eSWAGGER_JSON=/foo/my-file.json-v$PWD:/fooswagger-ui-local但是,这会忽略我的本地更改。我

java - 为什么使用 springfox 和 Swagger2 时 v2/api-docs 是默认 URL?

我刚刚开始使用swagger在此guide之后,但我发现了一些非常奇怪的东西,对我来说毫无意义。据我所知,当您拥有API版本号2的文档时,应该使用v2/api-docs。所以,默认应该只有api-docs,但出于某种奇怪的原因,我发现默认是v2/api-docs。检查我找到的库文档this.如何在以后无法使用v2的情况下覆盖该值?(当我的API达到v2但我还想展示遗留文档时)。或者也许我使用v2的概念是错误的?有人可以帮我解决这个问题吗? 最佳答案 /v2/api-docsURL是SpringFox用于文档的默认URL。v2不是指您

spring - 来自 Spring Hateoas 的文档 HAL "_links"( Swagger )?

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题,以便用事实和引用来回答它。关闭4年前。Improvethisquestion我想为我的客户开发团队记录一个REST服务。所以我将Spring-Hateoas中的一些Links添加到我的资源API,并将其插入swagger-springmvc@Api...注释来记录所有内容并为我的Angular团队提供良好的API引用,以便能够理解我的REST服务。问题是swagger无法发现哪些链接是可能的,只是给我一大堆Links而不说它们可能

json - Spring Pageable 接口(interface)的 Swagger 文档

我使用SpringBoot开发了一个微服务。RESTAPI的文档是用Swagger制作的。一些REST资源利用Spring概念免费提供分页。下面是一个例子:@RequestMapping(value="/buckets",method=GET)publicPagedResourceslist(Pageablepageable,PagedResourcesAssemblerassembler){returnbucketService.listBuckets(pageable,assembler);}如果我打开Swagger页面,资源可以使用以下表单:我遇到的问题是使用content-ty