api-coding.html


<!DOCTYPE HTML>
<html lang="zh-hans" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>api文件编写 · go-zero使用文档</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        <meta name="author" content="松妹子">
        
        
    <link rel="stylesheet" href="gitbook/style.css">

    
                <link rel="stylesheet" href="gitbook/gitbook-plugin-back-to-top-button/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-chapter-fold/chapter-fold.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-code/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search-pro/search.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-splitter/splitter.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-tbfed-pagefooter/footer.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-flexible-alerts/style.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-page-toc-button/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-pageview-count/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-prism/prism-tomorrow.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-theme-comscore/test.css">
                
            
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="business-coding.html" />
    
    
    <link rel="prev" href="model-gen.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="输入并搜索" />
</div>

            
                <nav role="navigation">
                

<ul class="summary">
    
    
        <li class="chapter " data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    简介
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2" data-path="about-us.html">
            
                <a href="about-us.html">
            
                    
                    关于我们
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.3" data-path="join-us.html">
            
                <a href="join-us.html">
            
                    
                    加入我们
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.4" data-path="concept-introduction.html">
            
                <a href="concept-introduction.html">
            
                    
                    概念介绍
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.5" data-path="quick-start.html">
            
                <a href="quick-start.html">
            
                    
                    快速开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.5.1" data-path="monolithic-service.html">
            
                <a href="monolithic-service.html">
            
                    
                    单体服务
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.5.2" data-path="micro-service.html">
            
                <a href="micro-service.html">
            
                    
                    微服务
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.6" data-path="framework-design.html">
            
                <a href="framework-design.html">
            
                    
                    框架设计
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.6.1" data-path="go-zero-design.html">
            
                <a href="go-zero-design.html">
            
                    
                    go-zero设计理念
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.2" data-path="go-zero-features.html">
            
                <a href="go-zero-features.html">
            
                    
                    go-zero特点
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.3" data-path="api-grammar.html">
            
                <a href="api-grammar.html">
            
                    
                    api语法介绍
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.4" data-path="api-dir.html">
            
                <a href="api-dir.html">
            
                    
                    api目录结构
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.5" data-path="rpc-dir.html">
            
                <a href="rpc-dir.html">
            
                    
                    rpc目录结构
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7" data-path="project-dev.html">
            
                <a href="project-dev.html">
            
                    
                    项目开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.1" data-path="prepare.html">
            
                <a href="prepare.html">
            
                    
                    准备工作
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.1.1" data-path="golang-install.html">
            
                <a href="golang-install.html">
            
                    
                    golang安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.2" data-path="gomod-config.html">
            
                <a href="gomod-config.html">
            
                    
                    go modudle配置
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.3" data-path="goctl-install.html">
            
                <a href="goctl-install.html">
            
                    
                    goctl安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.4" data-path="protoc-install.html">
            
                <a href="protoc-install.html">
            
                    
                    protoc&protoc-gen-go安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.5" data-path="prepare-other.html">
            
                <a href="prepare-other.html">
            
                    
                    其他
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.2" data-path="dev-specification.html">
            
                <a href="dev-specification.html">
            
                    
                    开发规范
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.2.1" data-path="naming-spec.html">
            
                <a href="naming-spec.html">
            
                    
                    命名规范
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.2.2" data-path="route-naming-spec.html">
            
                <a href="route-naming-spec.html">
            
                    
                    路由规范
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.2.3" data-path="coding-spec.html">
            
                <a href="coding-spec.html">
            
                    
                    编码规范
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.3" data-path="dev-flow.html">
            
                <a href="dev-flow.html">
            
                    
                    开发流程
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.4" data-path="config-introduction.html">
            
                <a href="config-introduction.html">
            
                    
                    配置介绍
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.4.1" data-path="api-config.html">
            
                <a href="api-config.html">
            
                    
                    api配置
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.4.2" data-path="rpc-config.html">
            
                <a href="rpc-config.html">
            
                    
                    rpc配置
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.5" data-path="business-dev.html">
            
                <a href="business-dev.html">
            
                    
                    业务开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.5.1" data-path="service-design.html">
            
                <a href="service-design.html">
            
                    
                    目录拆分
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.2" data-path="model-gen.html">
            
                <a href="model-gen.html">
            
                    
                    model生成
            
                </a>
            

        </li>
    
        <li class="chapter active" data-level="1.7.5.3" data-path="api-coding.html">
            
                <a href="api-coding.html">
            
                    
                    api文件编写
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.4" data-path="business-coding.html">
            
                <a href="business-coding.html">
            
                    
                    业务编码
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.5" data-path="jwt.html">
            
                <a href="jwt.html">
            
                    
                    jwt鉴权
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.6" data-path="middleware.html">
            
                <a href="middleware.html">
            
                    
                    中间件使用
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.7" data-path="rpc-call.html">
            
                <a href="rpc-call.html">
            
                    
                    rpc服务编写与调用
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.8" data-path="error-handle.html">
            
                <a href="error-handle.html">
            
                    
                    错误处理
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.6" data-path="ci-cd.html">
            
                <a href="ci-cd.html">
            
                    
                    CI/CD
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.7" data-path="service-deployment.html">
            
                <a href="service-deployment.html">
            
                    
                    服务部署
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.8" data-path="log-collection.html">
            
                <a href="log-collection.html">
            
                    
                    日志收集
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.9" data-path="trace.html">
            
                <a href="trace.html">
            
                    
                    链路追踪
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.10" data-path="service-monitor.html">
            
                <a href="service-monitor.html">
            
                    
                    服务监控
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.8" data-path="goctl.html">
            
                <a href="goctl.html">
            
                    
                    Goctl
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.8.1" data-path="goctl-commands.html">
            
                <a href="goctl-commands.html">
            
                    
                    命令大全
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.2" data-path="goctl-api.html">
            
                <a href="goctl-api.html">
            
                    
                    api命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.3" data-path="goctl-rpc.html">
            
                <a href="goctl-rpc.html">
            
                    
                    rpc命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.4" data-path="goctl-model.html">
            
                <a href="goctl-model.html">
            
                    
                    model命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.5" data-path="goctl-plugin.html">
            
                <a href="goctl-plugin.html">
            
                    
                    plugin命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.6" data-path="goctl-other.html">
            
                <a href="goctl-other.html">
            
                    
                    其他命令
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.9" data-path="component-center.html">
            
                <a href="component-center.html">
            
                    
                    组件中心
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.9.1" data-path="logx.html">
            
                <a href="logx.html">
            
                    
                    logx
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.2" data-path="bloom.html">
            
                <a href="bloom.html">
            
                    
                    bloom
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.3" data-path="executors.html">
            
                <a href="executors.html">
            
                    
                    executors
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.4" data-path="fx.html">
            
                <a href="fx.html">
            
                    
                    fx
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.5" data-path="mysql.html">
            
                <a href="mysql.html">
            
                    
                    mysql
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.6" data-path="redis-lock.html">
            
                <a href="redis-lock.html">
            
                    
                    redis-lock
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.7" data-path="periodlimit.html">
            
                <a href="periodlimit.html">
            
                    
                    periodlimit
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.8" data-path="tokenlimit.html">
            
                <a href="tokenlimit.html">
            
                    
                    tokenlimit
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.9" data-path="timing-wheel.html">
            
                <a href="timing-wheel.html">
            
                    
                    TimingWheel
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.10" data-path="tool-center.html">
            
                <a href="tool-center.html">
            
                    
                    工具中心
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.10.1" data-path="intellij.html">
            
                <a href="intellij.html">
            
                    
                    intellij插件
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.10.2" data-path="vscode.html">
            
                <a href="vscode.html">
            
                    
                    vscode插件
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.11" data-path="plugin-center.html">
            
                <a href="plugin-center.html">
            
                    
                    插件中心
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12" data-path="learning-resource.html">
            
                <a href="learning-resource.html">
            
                    
                    学习资源
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.12.1" data-path="wechat.html">
            
                <a href="wechat.html">
            
                    
                    公众号
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12.2" data-path="goreading.html">
            
                <a href="goreading.html">
            
                    
                    Go夜读
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12.3" data-path="gotalk.html">
            
                <a href="gotalk.html">
            
                    
                    Go开源说
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.13" data-path="practise.html">
            
                <a href="practise.html">
            
                    
                    开发实践
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.13.1" data-path="redis-cache.html">
            
                <a href="redis-cache.html">
            
                    
                    go-zero缓存设计之持久层缓存
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.2" data-path="buiness-cache.html">
            
                <a href="buiness-cache.html">
            
                    
                    go-zero缓存设计之业务层缓存
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.3" data-path="go-queue.html">
            
                <a href="go-queue.html">
            
                    
                    go-zero分布式定时任务
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.4" data-path="datacenter.html">
            
                <a href="datacenter.html">
            
                    
                    我是如何用go-zero 实现一个中台系统
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.5" data-path="stream.html">
            
                <a href="stream.html">
            
                    
                    流数据处理利器
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.6" data-path="online-exchange.html">
            
                <a href="online-exchange.html">
            
                    
                    10月3日线上交流问题汇总
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.14" data-path="dev-log.html">
            
                <a href="dev-log.html">
            
                    
                    开发日志
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.14.1" data-path="goctl-log.html">
            
                <a href="goctl-log.html">
            
                    
                    goctl开发日志
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.14.2" data-path="intellij-log.html">
            
                <a href="intellij-log.html">
            
                    
                    intellij开发日志
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.15" data-path="contributor.html">
            
                <a href="contributor.html">
            
                    
                    贡献人员
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.16" data-path="doc-contibute.html">
            
                <a href="doc-contibute.html">
            
                    
                    文档贡献
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.17" data-path="error.html">
            
                <a href="error.html">
            
                    
                    常见错误处理
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.18" data-path="source.html">
            
                <a href="source.html">
            
                    
                    相关源码
            
                </a>
            

        </li>
    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            本书使用 GitBook 发布
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    
<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >api文件编写</a>
    </h1>
</div>


                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h1 id="api&#x6587;&#x4EF6;&#x7F16;&#x5199;">api&#x6587;&#x4EF6;&#x7F16;&#x5199;</h1>
<h2 id="&#x7F16;&#x5199;userapi&#x6587;&#x4EF6;">&#x7F16;&#x5199;user.api&#x6587;&#x4EF6;</h2>
<pre class="language-"><code class="lang-shell">$ <span class="token function">vim</span> service/user/cmd/api/user.api
</code></pre>
<pre class="language-"><code class="lang-text">type (
    LoginReq {
        Username string `json:&quot;username&quot;`
        Password string `json:&quot;password&quot;`
    }

    LoginReply {
        Id           int64 `json:&quot;id&quot;`
        Name         string `json:&quot;name&quot;`
        Gender       string `json:&quot;gender&quot;`
        AccessToken  string `json:&quot;accessToken&quot;`
        AccessExpire int64 `json:&quot;accessExpire&quot;`
        RefreshAfter int64 `json:&quot;refreshAfter&quot;`
    }
)

service user-api {
    @handler login
    post /user/login (LoginReq) returns (LoginReply)
}
</code></pre>
<h2 id="&#x751F;&#x6210;api&#x670D;&#x52A1;">&#x751F;&#x6210;api&#x670D;&#x52A1;</h2>
<h3 id="&#x65B9;&#x5F0F;&#x4E00;">&#x65B9;&#x5F0F;&#x4E00;</h3>
<pre class="language-"><code class="lang-shell">$ <span class="token builtin class-name">cd</span> book/service/user/cmd/api
$ goctl api go -api user.api -dir <span class="token builtin class-name">.</span>
</code></pre>
<pre class="language-"><code class="lang-text">Done.
</code></pre>
<h3 id="&#x65B9;&#x5F0F;&#x4E8C;">&#x65B9;&#x5F0F;&#x4E8C;</h3>
<p>&#x5728;<code>user.api</code>&#x6587;&#x4EF6;&#x53F3;&#x952E;&#xFF0C;&#x4F9D;&#x6B21;&#x70B9;&#x51FB;&#x8FDB;&#x5165;<code>New</code>-&gt;<code>Go Zero</code>-&gt;<code>Api Code</code>&#xFF0C;&#x8FDB;&#x5165;&#x76EE;&#x6807;&#x76EE;&#x5F55;&#x9009;&#x62E9;&#xFF0C;&#x5373;api&#x6E90;&#x7801;&#x7684;&#x76EE;&#x6807;&#x5B58;&#x653E;&#x76EE;&#x5F55;&#xFF0C;&#x9ED8;&#x8BA4;&#x4E3A;user.api&#x6240;&#x5728;&#x76EE;&#x5F55;&#xFF0C;&#x9009;&#x62E9;&#x597D;&#x76EE;&#x5F55;&#x540E;&#x70B9;&#x51FB;OK&#x5373;&#x53EF;&#x3002;
<img src="https://zeromicro.github.io/go-zero/resource/goctl-api.png" alt="api&#x751F;&#x6210;">
<img src="https://zeromicro.github.io/go-zero/resource/goctl-api-select.png" alt="api&#x751F;&#x6210;&#x76EE;&#x5F55;&#x9009;&#x62E9;"></p>
<h3 id="&#x65B9;&#x5F0F;&#x4E09;">&#x65B9;&#x5F0F;&#x4E09;</h3>
<p>&#x6253;&#x5F00;user.api&#xFF0C;&#x8FDB;&#x5165;&#x7F16;&#x8F91;&#x533A;,&#x4F7F;&#x7528;&#x5FEB;&#x6377;&#x952E;<code>Command+N</code>&#xFF08;for mac OS&#xFF09;&#x6216;&#x8005; <code>alt+insert</code>&#xFF08;for windows&#xFF09;&#xFF0C;&#x9009;&#x62E9;<code>Api Code</code>&#xFF0C;&#x540C;&#x6837;&#x8FDB;&#x5165;&#x76EE;&#x5F55;&#x9009;&#x62E9;&#x5F39;&#x7A97;&#xFF0C;&#x9009;&#x62E9;&#x597D;&#x76EE;&#x5F55;&#x540E;&#x70B9;&#x51FB;OK&#x5373;&#x53EF;&#x3002;</p>
<h1 id="&#x731C;&#x4F60;&#x60F3;&#x770B;">&#x731C;&#x4F60;&#x60F3;&#x770B;</h1>
<ul>
<li><a href="api-grammar.html">api&#x8BED;&#x6CD5;</a></li>
<li><a href="goctl-api.html">goctl api&#x547D;&#x4EE4;</a></li>
<li><a href="api-dir.html">api&#x76EE;&#x5F55;&#x7ED3;&#x6784;&#x4ECB;&#x7ECD;</a>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.css"><script src="./javascript/gitalk.js"></script>
<div id="gitalk-container"></div>
<script>
var gitalk = new Gitalk({
"clientID": "b9f61eecd453fb93cefc",
"clientSecret": "8e70a3944fa689c13136aa56ea5bfb9945802bd2",
"repo": "go-zero-doc",
"owner": "zeromicro",
"admin": ["anqiansong"],
"id": window.location.pathname,      
"distractionFreeMode": false  
});
gitalk.render("gitalk-container");
</script>


</li>
</ul>
<footer class="page-footer"><span class="copyright">Copyright &#xA9; 2019-2021 go-zero all right reserved&#xFF0C;powered by Gitbook</span><span class="footer-modification">&#x6700;&#x540E;&#x66F4;&#x65B0;&#x65F6;&#x95F4;&#xFF1A;
2021-04-10 07:21:07
</span></footer>
<script>console.log("plugin-popup....");document.onclick = function(e){ e.target.tagName === "IMG" && window.open(e.target.src,e.target.src)}</script><style>img{cursor:pointer}</style>
                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                <a href="model-gen.html" class="navigation navigation-prev " aria-label="Previous page: model生成">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="business-coding.html" class="navigation navigation-next " aria-label="Next page: 业务编码">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"api文件编写","level":"1.7.5.3","depth":3,"next":{"title":"业务编码","level":"1.7.5.4","depth":3,"path":"business-coding.md","ref":"business-coding.md","articles":[]},"previous":{"title":"model生成","level":"1.7.5.2","depth":3,"path":"model-gen.md","ref":"model-gen.md","articles":[]},"dir":"ltr"},"config":{"plugins":["back-to-top-button","chapter-fold","code","-lunr","-search","search-pro","github","splitter","-sharing","sharing-plus","tbfed-pagefooter","flexible-alerts","page-toc-button","pageview-count","popup","hide-element","edit-link","-highlight","prism","theme-comscore"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"tbfed-pagefooter":{"copyright":"Copyright © 2019-2021 go-zero","modify_label":"最后更新时间：","modify_format":"YYYY-MM-DD HH:mm:ss"},"chapter-fold":{},"prism":{"lang":{"shell":"bash"},"css":["prismjs/themes/prism-tomorrow.css"]},"github":{"url":"https://github.com/tal-tech/go-zero"},"splitter":{},"search-pro":{},"sharing-plus":{"qq":false,"all":["facebook","google","twitter","instapaper","linkedin","pocket","stumbleupon"],"douban":false,"facebook":true,"weibo":false,"instapaper":false,"whatsapp":false,"hatenaBookmark":false,"twitter":true,"messenger":false,"line":false,"vk":false,"pocket":true,"google":false,"viber":false,"stumbleupon":false,"qzone":false,"linkedin":false},"popup":{},"code":{"copyButtons":true},"hide-element":{"elements":[".gitbook-link"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-comscore":{},"page-toc-button":{"maxTocDepth":2,"minTocSize":2},"back-to-top-button":{},"pageview-count":{},"flexible-alerts":{"danger":{"className":"danger","icon":"fa fa-ban","label":"Attention"},"note":{"className":"info","icon":"fa fa-info-circle","label":"Note"},"style":"callout","tip":{"className":"tip","icon":"fa fa-lightbulb-o","label":"Tip"},"warning":{"className":"warning","icon":"fa fa-exclamation-triangle","label":"Warning"}},"sharing":{"qq":false,"all":["douban","facebook","google","linkedin","twitter","weibo","qq","qzone","weibo"],"douban":false,"facebook":false,"weibo":true,"instapaper":false,"whatsapp":false,"hatenaBookmark":false,"twitter":false,"messenger":false,"line":true,"vk":false,"pocket":false,"google":true,"viber":false,"stumbleupon":false,"qzone":true,"linkedin":true},"edit-link":{"label":"编辑此页","base":"https://github.com/zeromicro/go-zero-doc/blob/master"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"松妹子","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"go-zero使用文档","language":"zh-hans","gitbook":"3.2.3"},"file":{"path":"api-coding.md","mtime":"2021-04-10T07:21:07.988Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2021-04-10T07:22:08.598Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-back-to-top-button/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-chapter-fold/chapter-fold.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-code/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search-pro/jquery.mark.min.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search-pro/search.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-github/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-splitter/splitter.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-sharing-plus/buttons.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-flexible-alerts/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-page-toc-button/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-pageview-count/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-hide-element/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-theme-comscore/test.js"></script>
        
    
    </body>
</html>