草庐IT

Swagger3

全部标签

go - 自定义 go-swagger 生成规范

我正在使用go-swagger通过命令swaggergeneratespec生成规范。一切正常,但我想减轻规范与实际实现之间可能存在的不匹配。例如,下面的模型在注释中有required:true(用于规范生成),以及用于实际验证的value:"required"(例如govalidator)//Currentmodel//swagger:parametersmyAPItypePoststruct{//thetitle//required:trueTitlestring`json:"Title"valid:"required"`//themessageMessagestring`json

go - 混淆从 proto 文件创建 swagger.json 文件

我已经为我打算生成的REST网络服务创建了一个包含所有必要消息和rpc函数的原型(prototype)文件。使用protoc-gen-swagger插件,我设法将该proto文件编译成swagger.json文件,一切看起来都很好,除了两件事,我似乎无法解决。swagger.json文件中的所有定义都以我的原型(prototype)文件包的名称为前缀。有办法摆脱这个吗?我消息的所有字段都是“可选的”。它们没有明确指定,但也没有指定为“必需”,根据定义,它们是可选的。Proto3不再支持必需/可选/重复,但即使我使用Proto2并添加这些关键字,它似乎也不会影响swagger.json输

go - 如何使用 flask_restplus 定义字典字段以用于使用 swagger codegen 生成的 go 代码?

我已经使用swaggerCLI生成go代码来调用我的flask应用程序。swaggercodegen将使用flask_restplus模型定义的fields.Raw类型转换为*interface{}ingo在go中使用*interface{}type将值赋值给字段返回prog.go:18:26:cannotusenotebook_spec_secrets(typemap[string]string)astype*interface{}inassignment:*interface{}ispointertointerface,notinterface你可以在这里测试https://pla

go - 如何设置 go-swagger 以从注释生成规范

我在此处遵循生成swagger规范的说明https://goswagger.io/generate/spec.html.我有一个现有项目需要API的UI。我想使用goswagger,但我完全糊涂了https://github.com/go-swagger/go-swagger/tree/master/examples/todo-list我想设置它,所以我在代码中添加注释,然后运行命令swaggergeneratespec它会生成规范但是,每当我运行它时,它都会打印{"swagger":"2.0","paths":{},"definitions":{}}这是我运行它的命令...com/p

go - 使用 golang 注释生成 Swagger 规范

我正在尝试使用Swagger为使用golang编写的RESTAPI创建文档。我一直在关注本指南:https://goswagger.io/generate/spec.html这样做并且能够根据我在主文件中的评论创建json文件,但是我不知道如何创建将转换为实际swagger规范的.yaml文件。我已按照页面上的说明进行操作,并将//go:generateswaggergeneratespec包含在我的主文件中。有人知道如何创建.yaml文件吗? 最佳答案 现阶段生成的spec是json不是yaml,不是说不能做yaml而是目前只生成

kubernetes REST Api详解(导入Swagger至Postman)

文章目录01引言02k8sRESTApi2.1步骤一:开启swagger2.2步骤二:导出swagger2.3步骤三:Postman导入2.4步骤四:本地调试03文末01引言备注:本文统一成kubernetes为k8s。首先贴上k8s的架构图:平时我们一般都会使用CLI(通常使用kubectl命令)去操作k8s,但是作为开发者,更为倾向的是使用RESTApi来操作k8s,其实k8s是支持的,那么如何查看这些API呢?本文主要讲解的是把k8s的swagger.json文件导出,然后导入到postman,最后使用postman对k8s进行操作,最终的效果图如下:02k8sRESTApik8sRES

linux - 如何从 swagger 文档生成静态 html 文件?

我创建了一个带有yaml文件的Swagger文档:api/swagger/swagger.yaml现在我想分享一个静态HTML文档及其定义,但它在swaggerproject上有说明,他们根本不打算支持HTML生成。如何从Swagger项目生成静态HTML文件? 最佳答案 我能想到的最简单的方法是使用SwaggerEditor:转到:https://editor.swagger.io点击顶部菜单栏中的"file",然后选择“导入文件”导入后点击顶部菜单栏中的“生成客户端”,然后选择“HTML”或“HTML2”生成静态HTML文档ed

php - 使用 SLIM 和 SWAGGER 的 RESTful API 文档?

我是新手,但我喜欢它。我使用SlimFramework做了一个小的RESTApi。现在我想要一份关于它的持续文档。我认为swagger是正确的选择,但我还没有找到如何集成它的方法?干杯,感谢您的耐心等待:) 最佳答案 我认为您正在寻找这个项目:zircote/swagger-phpHere您将了解如何根据用户对URL的请求生成文档。基本上你必须用SwaggerAnnotations来注释你的代码,然后在Slim中用类似这样的代码创建另一个路由:getResource('/pet',array('output'=>'json'));它

还在用Swagger?我推荐这款零代码侵入的接口管理神器

静态的Swagger们跟不上频繁变更的代码“为什么改了这个没告诉我”,“实际功能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的,有时候任务比较急,就先改了代码,想着以后再同步文档,然后就给忘了。项目更新又全靠社交软件通知,人一多难免有一两个没及时沟通到的。确实给合作的小伙伴带来麻烦,但说实话开发也挺委屈的。这些问题产生的主要原因是,当前大部分研发团队的工作流程是这样的:​添加图片注释,不超过140字(可选)旧协作模式这种模式带来的问题是:1.Swagger,postman,MockJS只能完成软件研发流程中某个环节的功能,完成接口设计,文档编写,调试,测试验证等工

Swagger配置与使用

文章目录前言作为后端开放人员,最烦的事就是自己写接口文档和别人没有写接口文档,不管是前端还是后端开发,多多少少都会被接口文档所折磨,前端会抱怨后端没有及时更新接口文档,而后端又会觉得编写接口文档太过麻烦。Swagger可以较好的接口接口文档的交互问题,以一套标准的规范定义接口以及相关的信息,就能做到生成各种格式的接口文档,生成多种语言和客户端和服务端的代码,以及在线接口调试页面等等。只需要更新Swagger描述文件,就能自动生成接口文档,做到前端、后端联调接口文档的及时性和便利性。一、简介官网:https://swagger.io/Swagger是一个规范且完整的框架,用于生成、描述、调用和可