swagger相关内容
我正在使用Swashbuckle在我的.Net Core WebAPI项目中生成Swagger.如下所示,它将生成字符串类型的GUID.我想生成一个随机Guid并将"string"替换为“"或一个空的GUID"00000000-0000-0000-0000-000000000000".这将使我的示例在发布时可以真正发挥作用. { "payload": [ { "GUI
..
我正在寻找一种通过摇摇欲坠的API(yaml/json文件)为java google终结点后端项目生成服务器存根的方法. 有什么建议吗? 干杯, 阿萨夫 解决方案 最简单的方法是将Swagger/OpenAPI规范导入到 https://editor.swagger.io ,然后在顶部菜单栏中单击“生成服务器",然后选择与Java相关的服务器存根(例如JAX-RS,Spring
..
我正在尝试使用Swagger为用golang编写的REST API创建文档.我一直在遵循此指南: https://goswagger.io/generate/spec.html 至这样做,已经能够从主文件中的注释创建json文件,但是我不知道如何创建将转换为实际swagger规范的.yaml文件.我已按照页面上的说明进行操作,并在主文件中包含了//go:generate swagger gener
..
背景 使用 Swagger编辑器,我为我的API创建了一个规范. 我看到Swagger在其Swagger编辑器中还提供了“生成客户端"选项(可能使用 Swagger Codegen ). 客观 我想生成一个客户端并将其用于我的React应用程序(通过 create-react-创建应用),并且最好享受一些静态输入功能(当前使用流). 当前 Swagger编辑器中的所有
..
是否可以从firebase云函数中的函数注释生成Swagger Spec文件?如果是这样,我们该怎么办? 我看到云功能代码更像是无服务器的代码,所以想知道这是否可能. 解决方案 我还没有找到一种自动方法,但是有很多库可供选择. 我在Firebase Function实现中使用express和nodejs,对我来说, 可以通过以下库来实现Swagger文档生成: https://
..
我使用Spring Boot和集成的swagger-ui(springfox-swagger2),并且希望能够选择一次上传多个文件.不幸的是,Swagger UI似乎不允许这样做,至少没有提供我的控制器方法. 我的控制器方法签名: @ApiOperation( value = "batch upload goods cover image", notes = "bat
..
我试图用我的 swagger-ui 打开我自己生成的swagger规范文件my.json本地计算机. 所以我下载了最新标签v2.1.8-M1并提取了邮政编码.然后我进入子文件夹dist并将文件my.json复制到其中.现在,我打开了index.html并想浏览my.json.问题开始了: 如果输入本地路径,它将始终以包含index.html的当前URL作为前缀.因此,我无法打开文件.我
..
我正在尝试编辑我的express-swagger项目,并按照本教程将输入验证添加到快速应用程序中 我使用 swagger-express-mw 包使用,但不清楚如我上面提到的教程中所述,我可以在哪里添加中间件.具体来说,我无法拦截我的请求,但出现typeError: TypeError: req.checkBody is not a function at saveN
..
我开始使用带有 swagger-ui-express 和 swagger-jsdoc 的swagger自动记录我现有的API,该API是用 nodejs 并表达(如此处所述-示例). 当我尝试将$ref添加到注释中现有的 JSON Schema 文件(与所有js文件位于同一目录中的项目内)时,遇到一个问题. 我的目录如下 我尝试编写本地路径(./schema.json)和绝对路径
..
下面是从python执行中生成的YAML requestBody: 内容: application / json : 模式: 属性: element_ids: 项目: 类型:字符串 类型:数组 element_type: 项目: 枚举: -NC -CELL 类型:字符串 类型:数组 expires_in: 格式:int32 类型:整数 group_id: 类型:字符串 必需
..
我们正在使用Swashbuckle记录我们的WebAPI项目(使用Owin),并正在尝试修改生成的Swashbuckle的Swagger文件。 使用 DescribeAllEnumsAsStrings()和下面的枚举属性,可以得到预期的结果: class MyResponseClass { public Color颜色; } 枚举Color { LightBlue, Lig
..
我有以下两个实体类。 第一类是 SampleApiEntity : 打包my.company.rest; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import org.hibernate.annotations.Type; impo
..
我正在使用Springfox v 2.7,我想从JSON文件生成Swagger UI,以保持控制器类整洁,并且没有Swawgger(@ Api,@ ApiDocs)的注释,或者我的模型类没有任何注释(@ApiModelProperty等)。... 致谢! PD:这是Spring Boot 1.5 .8版本的应用程序。 解决方案 以下是您需要进行的更改: 仅需要Spring
..
人们是否使用某种标准来记录他们的库和框架? 理想情况下,它将使用JSON或YAML并允许生成能很好地呈现它的HTML页面。 解决方案 SDK文档最常用的方法是根据源代码中的注释生成文档。这样,可以轻松地使类/函数参考文档与实现保持同步。 有用于不同编程语言和框架的文档生成器。某些工具可让您将生成的参考文档与手动编写的概念性主题相结合(概述,“入门”等)。 一些受欢迎的工具
..
我必须记录我的API。我必须使用其中任何一个 Slate 或 Swagger 。我想知道哪个有更多的选择,利弊,哪个更好。 解决方案 Swagger和Slate提供两种不同的选择目的。 Swagger是尝试以一种描述RESTful API的标准化方式(例如,类似于 ApiBlueprint ) Swagger是基于JSON的API定义格式,用于描述REST API。 〜 API
..
我正在尝试使用“尝试”按钮创建一个html。 swagger-code gen或swagger-ui都给我这个结果。您有任何建议吗? 解决方案 您可以尝试更改将Swagger UI 转换为“一个大的HTML杂乱文件”,如下所示: 下载Swagger用户界面(链接到最新的母版)。 转到 dist 文件夹。 编辑 index.html 如下: 删除
..
我们有一个完全使用docker化的Web应用程序,带有针对该API的有效Swagger定义。该API在其自己的Docker容器中运行,我们正在使用docker-compose来协调所有内容。我想基于位于 http:// api:8443 / apidocs.json 的Swagger定义生成Ruby客户端。 我在此处中浏览了文档,这使我想到了http://generator.swagger.
..
假设我们有这样的URL- localhost:8000 / object?name = STH 。任何人都知道如何显示名称的对象等于 STH 使用Django Swagger文档吗? class ObjectList(GenericAPIView): serializer_class = ObjectSerializer def get(self,request): try
..
我有一个django rest后端应用程序,我用招摇工具向FE查找和记录我的api。 这工作正常,但我进行了一些更改,但现在出现此错误: 内部服务器错误:/ 追溯(最近一次通话最近): 文件“ /home/notsoshabby/.local/share/virtualenvs/panda_pitch-UBt5SNMA/lib/python3.7/ site-packages / d
..
我有一些URL要从我的REST API文档中排除。我正在使用Django REST Swagger和我能找到的唯一文档( https://github.com/ marcgibbons / django-rest-swagger )并没有告诉我很多。在settings.py中有SWAGGER_SETTINGS的“ exclude_namespaces”部分,但是没有如何使用它的真实解释或示例。
..