WebStorm最新试用版
如果您正在使用RESTful应用程序或正在开发REST API又或是在代码中使用过它们，那么你可能对OpenAPI和Swagger有所了解。如果您不了解Swagger，那么你需要记住Swagger是可以帮助您为API创建文档的一组工具，而OpenAPI是用于描述REST API端点的格式。
首先，我们需要安装OpenAPI Specification插件。从插件存储库或IDE Settings| Plugins项卡中的”Marketplace tab” 安装它。
向项目添加OpenAPI规范
要在您的项目中创建新的API规范，请使用file “New…”菜单或“ project view” 中的“ new…”弹出窗口，然后选择“ OpenAPISpecification”。您可以在JSON和YAML之间选择。
WebStorm将在代码完成弹出窗口中为您显示带有简短描述的部分名称，并且IDE还将检查该文件是否具有所有必需的部分。
代码中完成API
规格文件中最重要的部分是” paths “部分列出了可用的端点及其支持的HTTP方法。在项目中的任何地方都有规格文件后，您就可以在JavaScript和TypeScript代码中查看有关这些API的建议。
当前，它们在两种情况下显示：
- 用 fetch()方法调用
- 从axios库中使用get()或post()类似的方法
我们计划在不久的将来增加对Express方法的支持。
在您的项目中拥有正确的OpenAPI规范不是从这些完成建议中受益的唯一方法–您还可以指定一个可以使用该规范的URL。为此，请转到“Preferences/Settings | Languages and Frameworks | OpenAPI Specification”。单击加 图标，然后将链接粘贴到JSON或YAML文件。
如果您使用的是某些第三方服务的API，则可以检查GitHub上的openapi-directory存储库（在APIs文件夹中）是否有 区维护的OpenAPI规范。如果存在，则获取指向规范文件的直接链接，并将该URL添加到IDE Preferences/Settings中
使用HTTP客户端测试API调用
WebStorm具有内置的HTTP客户端，可用于测试REST API。
在OpenAPI规范文件中，您可以通过单击方法旁边的图标，以HTTP客户端理解的格式快速生成新请求。然后，您可以根据需要使用代码完成建议来添加其他参数。
或者，您可以使用意图直接从JavaScript或TypeScript文件中创建新请求。 当插入符 位于fetch或axios方法中URL上时按Alt + Enter，然后选择Generate request。
您可以将授权和任何其他env变量存储在特殊的位置（http-client.private.env.json文件–在WebStorm文档中找到有关此内容的更多信息）。
该插件具有许多有用的功能，您可以尝试；我将重点介绍其中两个。一种是与OpenAPI代码生成器集成，您可以使用它来创建基于API规范的库。另一个是“ 与最新规格修订比较”操作，您可以从“ Find Action”弹出窗口中调用该操作（Cmd / Ctrl + Shift + A） ），并用于查找项目的OpenAPI规范中引入的任何重大更改。
结束
今天的内容就到这里，欢迎下载Webstorm体验最新功能并在下方评论区分享您对该产品的想法。您的反馈意见可帮助我们在以后的文章教程中找到正确的方向，作为JetBrains的正版代理商现WebStorm正版授权最低仅售529！
标签：
声明：本站部分文章及图片源自用户投稿，如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢！