创建 REST API 定义文件

可以使用向导来生成模板 swagger.json 文件,以指定具象状态传输 (REST) 应用程序编程接口 (API)。此向导支持以 Liberty 服务器为目标并使用 Web 2.5 及更高版本的项目。

关于此任务

要点: 适用于 Liberty 和 Liberty Core

过程

  1. 创建一个以 Liberty 服务器为目标的 Web 项目。

    有关创建 Web 项目的更多信息,请参阅创建 Web 项目。

  2. 要创建 Swagger REST API 定义文件,请完成下列其中一个选项:
    • 选择文件 > 新建 > 其他,然后在“REST API 定义”部分中选择 Swagger REST API 定义文件。
    • 右键单击项目,然后选择新建 > Swagger REST API 定义文件。
  3. 选择要创建的 JavaScript 对象表示法 (JSON) 文件的类型:
    • 要创建包含所有必需的顶级 Swagger 元素的文件,请选择创建 swagger.json 模板文件。
    • 要创建包含公共定义的样本内容(例如 GET、PUT 和 POST)的文件,请选择创建 swagger.json 样本文件。
  4. 选择要创建的文件的位置:
    • 要使用 Swagger 注释,请选择生成为存根文档(META-INF/stub 目录)。
    • 如果未在使用 Swagger 注释,请选择生成为顶级文档(META-INF 目录)。
      注: 缺省情况下,此选项是选中的。
  5. 单击完成。

结果

工具将会在您的 Web 项目的 WebContent/META-INF 文件夹中生成 swagger.json 文件。此文件将在缺省 JSON 编辑器中打开。

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html