AWS 文档 - AWS 适用于 VS Code 的工具包

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

AWS 文档

AWS Toolkit for Visual Studio Code 支持 AWS Serverless Application Model JSON Schema 用于 AWS SAM templates,通过在 VS Code 中直接提供定义、自动完成和验证功能,提升模板编写体验。AWS文档支持所有 AWS SAM 资源和 CloudFormation 资源。有关更多详细信息,请参阅以下资源:

  • 有关 JSON 架构的具体信息,请参阅 JSON 架构 JSON-Schema.org 网站。

  • 有关 AWS SAM 模板的更多信息,请参阅《AWS Serverless Application Model 开发人员指南》中的 AWS SAM 模板剖析主题。

  • 有关 AWS 资源和属性类型的更多信息,请参阅《CloudFormation 用户指南》中的 AWS 资源和属性类型参考主题。

  • 有关 AWS Toolkit 使用的 AWS SAM 架构的详细信息,请参阅 AWS GitHub 存储库中的 AWS Serverless Application Model 架构。

开始使用 AWS 文档

要开始在 VS Code 中使用 AWS 文档,请从 IDE 或 VS Code Marketplace 安装 AWS Toolkit for Visual Studio Code 扩展程序,然后打开任意 AWS SAM 模板。

在 VS Code 中查看文档、自动完成和验证

查看文档、自动完成和验证是 AWS Toolkit 中包含的功能。有关这些功能在 VS Code 中的具体呈现效果示例,请参见下图。

  • 要从打开的 AWS SAM 模板中查看文档,请将指针悬停在文档中的行条目上。

  • 对于自动完成,请开始在 AWS SAM 模板中键入内容,以激活弹出窗口,其中包含基于输入的建议。

  • 系统会自动扫描 AWS SAM 模板以进行验证,错误会以灯泡图标突出显示,单击该图标即可获取更多建议。

有关这些功能在 VS Code 中的具体呈现效果示例,请参见下图。

RestApiId property details for AWS::Serverless::Api resource in AWS SAM template.