api file format

api file format

Overview

After the api file is written, the content of our api is uneven, as follows

syntax= "v1"

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

type Foo {
  Bar string
    Baz int
}

This api file is not read. We can use goctl api format to format api files.

Task Targets

1. familiar with the use of goctl api format
2. Learn about the function of the goctl api format command

Preparing

1. Complete goctl installation

Format api file

1. Create an api file and copy the following content to the demo.api file

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
}

1. Create workspace and directory

$ mkdir -p ~/workspace/api/format

1. Copy the above demo.api files to ~/workspace/api/format under directory

2. Format api file

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

1. View formatted api files

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
}