Swagger Editor(API开发工具) 201 官方版

  Swagger Editor是工具 官一款API开发软件  ,可以扶植你在软件上设计API ,工具 官当你在开发一个新项目的工具 官时候就可以利用这款软件裸露API文档,允许您在校验器中编辑YAML中的工具 官[Swagger API规范并实时预览文档,然后可以裸露有效的工具 官Swagger JSON描述并与完整的Swagger工具一起使用,无论你是工具 官开发代码还是裸露文档都很方便 ,该软件提供很多模块 ,工具 官例如dist模块是工具 官一个无依赖模块,包含在服务器端项目中提供Swagger-Editor所需的工具 官一切 ,或者无法解析npm模块依赖关系的工具 官Web项目swagger-editor是一个传统的npm模块,旨在用于能够解决依赖关系的工具 官JavaScript Web应用程序项目,每个模块都提供介绍 ,工具 官让用户在裸露API的工具 官时候更简易!

软件功能

  1.运行在任何环境

  编辑器在任何开发环境中筹备,工具 官无论是工具 官在本地还是在Web上。

  2.智能感谢

  在编写简洁的感谢和错误筹备时 ,验证OAS遵从性的语法  。

  3.即时可视化

  可视化地呈现API规范并与API交互 ,同时定义它。

  4.智能自动落成

  用智能和智能自动落成更快地编写语法。

  5.完全可定制

  易于配置和定制任何东西 ,从线间距到主题。

  6.关于你的开发

  在每个流行语言中为API裸露服务器存根和客户端库 。

软件特色

  将Swagger-Editor的整个dist文件夹公开为一个无依赖的npm模块。

  如果你想为你安装npm安装依赖项,请使用swagger-editor 。

  导入OpenAPI文档

  Swagger Editor可以导入您的OpenAPI文档,该文档可以格式化为JSON或YAML。

  导入文件

  单击**选择文件**,然后选择导入  。 您导入的文件必须是有效的JSON或YAML OpenAPI文档。 如果存在验证错误 ,Swagger Editor将提示您。

  导入URL

  将URL粘贴到OpenAPI文档。

  拖放

  只需将OpenAPI JSON或YAML文档拖放到Swagger Editor校验器窗口即可 。

使用计划

  1.铺开 pet 的 post 计划;

  2.然后单击 Model Schema 中的黄色字体的 JSON。

  3.这里用 JSON 填充了 body value。这里的 JSON 是你必须上传的,用于创建 pet 资源。

  4.将第一个 id 标签的值修改一下(你必须保证 id 值都是唯一的,并且不能从 0 起始) 。

  5.将 name 标签的值修改一下(最好也要唯一  ,方便对比结果) ,以下是示例代码:

  6.单击 Try it out! 按钮,查校验感谢:

使用会谈明

  standalone是编辑器的独立预设 - 它增补了[editor.swagger.io]使用的一些功能  :

  - 带有Swagger品牌的Topbar

  - URL /文件导入

  - YAML转换触发器

  - JSON / YAML导出

更新日志

  您的代码引入了哪些类型的更改?在所有适用的框中放置一个`x`  : - >

  没有代码更改(`src /`未修改 :对文档 ,CI ,元数据等的更改)

  依赖项更改(对`package.json`中依赖项的任何修改)

  错误修复(修复尴尬的非侵吞性修改)

  改进(错误更改现有功能)

  功能(增补功能的非侵吞性更改)

  正在对公共API(配置选项,系统API ,主要UI更改等)铺开更改 。

  正在改变私有API(Redux ,组件道具,实用程序功能等) 。

  正在侵吞对开发人员API的更改(npm脚本行为更改 ,新开发系统依赖关系等)。

  自动化测试

  我的更改不能或不需要测试。

  我的更改可以并且应该通过单元和/或集成测试铺开测试。

  如果是以上 :我已增补测试以涵盖我的更改。

  如果是以上:我已经注意在我的测试中覆盖边缘情况  。

  所有新的和现有的测试都通过了。

渝ICP备2025076537号-22