Appia OpenAPI Language Service 1.18.0

Appia OpenAPI Language Service是一款与Appia Marketplace无缝对接的语言服务器，旨在通过提供OpenAPI自动补全和验证功能，提升您的API开发效率。

配置指南：

要开始使用，请在VSCode中通过点击⚙图标来配置扩展：

• 将Appia Marketplace URL设置为Appia Marketplace的完整URL。例如，可以使用https://appia-marketplace.example.com。
• 确保您的文件具有扩展名，如json或yaml。

附加信息：

• 对于特定文件，请禁用GitHub Copilot。
• 文件需要保存以启用扩展功能。
• 注意缩进！主要条目不应有缩进。

自动补全功能：

x-appia-consume-from属性支持自动补全，并能为您完成必要的脚手架工作。不过，需要注意以下几点：

• 首次加载可能需要超过18秒来获取可消费的URL列表（之后会更快）。
• 输入字母时要谨慎，因为它会直接尝试过滤结果（建议先从一个字母开始）。
  • 可以滚动浏览整个列表。
  • 通过使x-appia-consume-from值更具体来缩小列表。
  • 完全填写条目（如从swagger找到的URL），然后输入分号并触发自动补全。

使用方法：

在创建消费者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规范）、请求和响应规范以及相应的模型。

文件中条目的顺序无关紧要，但应包括：

• openapi：（手动输入）
• x-appia-consume-from：（半自动输入）
• servers：（通过x-appia-consume-from后的URL自动生成）
• info：（通过x-appia-consume-from后的URL自动生成）
• tags：（通过x-appia-consume-from后的URL自动生成）
• paths：（半自动输入）
• components：（通过路径后的条目自动生成）

通过Appia OpenAPI Language Service，您可以更高效地进行API开发，享受智能自动补全带来的便捷体验。