Appia OpenAPI Language Service是一款与Appia Marketplace无缝对接的语言服务器,旨在通过提供OpenAPI自动补全和验证功能,提升您的API开发效率。
配置指南:
要开始使用,请在VSCode中通过点击⚙图标来配置扩展:
附加信息:
自动补全功能:
x-appia-consume-from属性支持自动补全,并能为您完成必要的脚手架工作。不过,需要注意以下几点:
使用方法:
在创建消费者API规范时,创建一个以openapi: 3.0.0
开头的新文件。您的文档应如下所示:
openapi: 3.0.0
首先,选择您希望用于自动补全的源。自动补全x-appia-consume-from属性。
openapi: 3.0.0
x- # <-- 在此处自动补全
您将看到x-appia-consume-from属性的自动补全选项。
然后,自动补全一个API规范源。该URL处的文档将用作您的消费者OpenAPI规范的源。例如,若要使用Web网关的规范,选择URL https://appia-marketplace.example.com/gateway/web.json。
此时,您的文档应包含服务器、信息块、标签和安全性信息。
通过自动补全路径块来添加一些API和组件。
openapi: 3.0.0
x-appia-consume-from: https://appia-marketplace.example.com/gateway/web.json
p # <-- 在此处自动补全
# 其他内容
路径属性应被自动补全。
接下来,选择一个可用的API:
openapi: 3.0.0
x-appia-consume-from: https://appia-marketplace.example.com/gateway/web.json
paths:
/ # <-- 在此处自动补全
# 其他内容
然后选择一个API。例如,我们将使用/demo-service/information。
接下来,自动补全可用的HTTP方法,例如GET:
openapi: 3.0.0
x-appia-consume-from: https://appia-marketplace.example.com/gateway/web.json
paths:
/demo-service/information:
g # <-- 在此处自动补全
# 其他内容
整个API内容将被自动补全,包括操作(API规范)、请求和响应规范以及相应的模型。
文件中条目的顺序无关紧要,但应包括:
通过Appia OpenAPI Language Service,您可以更高效地进行API开发,享受智能自动补全带来的便捷体验。
本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!
本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!
如有侵权请联系我们删除下架,联系方式:study_golang@163.com