余温旧梦-王世彪的博客
关注公众号
  • 开发桌面程序
  • javascript教程
  • css样式
  • vuejs
  • 部署免费CDN
  • SEO搜索引擎优化
  • vuepress教程
  • redis分布式缓存
  • Golang
  • PHP
  • Python
  • Java
  • NodeJs
  • tomcat
  • ELK
  • Mysql数据库
  • Nosql数据库
  • C/C++底层开发
  • 音视频/流媒体
  • linux服务器
  • nginx服务器
  • 容器技术
  • 负载均衡
  • 项目管理
  • 持续集成
  • 大数据
  • 微信公众号运营
  • markdown用法
赞一个
友链
联系作者

王世彪

努力做个影响他人滴人
关注公众号
  • 开发桌面程序
  • javascript教程
  • css样式
  • vuejs
  • 部署免费CDN
  • SEO搜索引擎优化
  • vuepress教程
  • redis分布式缓存
  • Golang
  • PHP
  • Python
  • Java
  • NodeJs
  • tomcat
  • ELK
  • Mysql数据库
  • Nosql数据库
  • C/C++底层开发
  • 音视频/流媒体
  • linux服务器
  • nginx服务器
  • 容器技术
  • 负载均衡
  • 项目管理
  • 持续集成
  • 大数据
  • 微信公众号运营
  • markdown用法
赞一个
友链
联系作者
  • 分布式缓存

  • 分布式存储

  • mysql

  • postgresql

  • mongodb

  • c或c++

  • golang

    • 环境配置

    • 基础

    • 单元测试

    • 后台管理脚手架

    • web框架gin

    • web框架echo

    • web框架GoFrame

    • 微服务框架go-micro

    • 微服务

      • 安装etcd
      • 安装消息服务rocketmq
      • 安装protobuf
      • 基于proto文件生成rpc接口定义文档
        • Makefile示例
    • 接口管理

    • orm框架gorm

    • 开源论坛

    • 爬虫

  • php

  • java

  • nodejs

  • python

  • tomcat

  • elk

  • 音视频流媒体

  • 后台
  • golang
  • 微服务
王世彪
2022-03-11
目录

基于proto文件生成rpc接口定义文档

# 基于proto文件生成rpc接口定义文档

本文介绍如何生成.proto文件的接口定义文档。生成的文档支持markdown格式、html网页格式。

# Makefile示例

PROTO_DIR=./proto
DOC_DIR=./doc

#生成proto文件的markdown接口定义文档
protodoc-markdown:
	@go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
	@mkdir -p $(DOC_DIR)
	@protoc --doc_out=$(DOC_DIR) --proto_path=$(PROTO_DIR) --doc_opt=markdown,$(DOC_DIR)/proto.md $(PROTO_DIR)/*.proto

#生成proto文件的html接口定义文档
protodoc-html:
	@go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
	@mkdir -p $(DOC_DIR)
	@protoc --doc_out=$(DOC_DIR) --proto_path=$(PROTO_DIR) --doc_opt=html,$(DOC_DIR)/proto.html $(PROTO_DIR)/*.proto
#微服务#proto
上次更新: 2022-03-11 17:52:35
安装protobuf
go-swagger解析swagger.json并渲染为页面

← 安装protobuf go-swagger解析swagger.json并渲染为页面→

最近更新
01
mysql创建用户
04-09
02
golang错误处理最佳实践
03-17
03
git其它
03-03
更多文章>
Theme by Vdoing | Copyright © 2019-2022 王世彪 | MIT License
冀ICP备19016776号-1
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式