Skip to main content

api 文件格式化

概述

在 api 文件编写完之后，我们的 api 内容参差不齐，就有如下内容：

syntax= "v1"

info(
key1:value1
key2:value2
longkey:longvalue
)

type Foo {
  Bar string
    Baz int
}

这样的 api 文件不利于阅读，我们可以使用 goctl api format 命令对 api 文件进行格式化。

任务目标

  1. 熟悉 goctl api format 命令的使用
  2. 了解 goctl api format 命令的功能

准备条件

  1. 完成 goctl 安装

格式化 api 文件

  1. 创建 api 文件，将如下内容拷贝到 demo.api 文件中：

    syntax = "v1"

    type User {
        Id int64 `json:"id"`
        Name string `json:"name"`
        Age int `json:"age"`
        Description string `json:"description"`
    }

    type Student {
        Id int64 `json:"id"`
        No int64 `json:"no"`
        Name string `json:"name"`
        Age int `json:"age"`
        Description string `json:"description"`
    }

    service User {
        @handler ping
        get /ping
    }

  2. 创建工作空间和目录

    $ mkdir -p ~/workspace/api/format

  3. 将上文中的 demo.api 文件拷贝到 ~/workspace/api/format 目录下

  4. 格式化 api 文件

    $ cd ~/workspace/api/format
    $ goctl api format --dir demo.api

  5. 查看格式化后的 api 文件

    syntax = "v1"

    type User {
        Id          int64  `json:"id"`
        Name        string `json:"name"`
        Age         int    `json:"age"`
        Description string `json:"description"`
    }

    type Student {
        Id          int64  `json:"id"`
        No          int64  `json:"no"`
        Name        string `json:"name"`
        Age         int    `json:"age"`
        Description string `json:"description"`
    }

    service User {
        @handler ping
        get /ping
    }

Contents