自动生成 Restful API 文档？我有神器

文档是在编写完API接口并运行服务后自动生成的

1. 可参考此文档安装go chassis

   https://go-chassis.readthedocs.io/en/latest/getstarted/install.html

2. 我们现在使用go chassis，开编写一个服务，完整例子。

首先编写API，定义好API已经对应的方法

type RestFulHello struct {}

func (r *RestFulHello) Sayhello(b *restful.Context) {
    b.Write([]byte("get user id: " + b.ReadPathParameter("userid")))
}func (s *RestFulHello) URLPatterns() []restful.Route {
    return []restful.RouteSpec{
        {http.MethodGet, "/sayhello/{userid}", "Sayhello"},
    }
}

将此结构体注册到go chassis

chassis.RegisterSchema("rest", &RestFulHello{})

编写最基本的配置信息，包括监听端口和service center地址

cse:
  service:
    registry:
      address: http://127.0.0.1:30100
  protocols: # what kind of server you want to launch
    rest: #launch a http server
      listenAddress: 127.0.0.1:5001

为服务取名字

service_description:
  name: RESTServer # name your provider

最后在main函数中启动服务

func main() {
    //start all server you register in server/schemas.
    if err := chassis.Init(); err != nil {
        lager.Logger.Error("Init failed.", err)
        return
    }
    chassis.Run()
}

最后

go build main.go
./main