Plugin Commands

[!TIP] This document is machine-translated by Google. If you find grammatical and semantic errors, and the document description is not clear, please PR

Goctl supports custom plugins for api, so how do I customize a plugin? Let's take a look at an example of how to finally use it below.

$ goctl api plugin -p goctl-android="android -package com.tal" -api user.api -dir .

The above command can be broken down into the following steps:

  • goctl parsing api file
  • goctl passes the parsed structure ApiSpec and parameters to the goctl-android executable file
  • goctl-android customizes the generation logic according to the ApiSpec structure.

The first part of this command goctl api plugin -p is a fixed parameter, goctl-android="android -package com.tal" is a plugin parameter, where goctl-android is the plugin binary file, and android -package com.tal is a custom parameter of the plugin , -Api user.api -dir. Is a common custom parameter for goctl.

How to write a custom plug-in?

A very simple custom plug-in demo is included in the go-zero framework. The code is as follows:

package main

import (


func main() {
    plugin, err := plugin.NewPlugin()
    if err != nil {
    if plugin.Api != nil {
        fmt.Printf("api: %+v \n", plugin.Api)
    fmt.Printf("dir: %s \n", plugin.Dir)
    fmt.Println("Enjoy anything you want.")

plugin, err := plugin.NewPlugin() The function of this line of code is to parse the data passed from goctl, which contains the following parts:

type Plugin struct {
    Api   *spec.ApiSpec
    Style string
    Dir   string

[!TIP] Api: defines the structure data of the api file

Style: optional, it is used to control file naming conventions

Dir: workDir

Complete android plugin demo project based on plugin

Guess you wants

Copyright © 2019-2021 go-zero all right reserved,powered by GitbookLast UpdateTime: 2021-12-05 09:48:50

results matching ""

    No results matching ""