go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/tools/cmd/apigen/doc.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package main hosts the Cloud Endpoints API generator utility.
    16  //
    17  // This utility is intended to be used with `go generate` to automatically
    18  // generate Cloud Endpoints Go stubs. It is closely tired to the
    19  // `google-api-go-generator` tool (
    20  // https://github.com/google/google-api-go-client).
    21  //
    22  // `apigen` detects a methods of operation by parsing its target's `app.yaml`
    23  // file. It configures and executes a Cloud Endpoints frontend server for the
    24  // target application, then runs `google-api-go-generator` against it. The
    25  // resulting APIs are aggregated in a Go package destination.
    26  //
    27  // The generated APIs are also patched as they are installed in order to add
    28  // LUCI-Go-conforming structure.
    29  //
    30  // For more information, see the `example/...` subdirectory, which contains
    31  // example AppEngine and Managed VM services and their generated stubs.
    32  package main