AspnetCore 2.0 自动API文档生成组件,支持protobuffer

关于

API文档自动生成,用于对APP端的开发帮助文档生成,默认传输格式。

本项目并不是风格,是面向功能的API类型。ApiDoc的作用是根据定义好的API接口和注释来自动生成给内部开发者提供的API对接文档。

欢迎一下,后续还会更新配套的SDK自动生成,基于Consul的服务注册与发现等,当然,由于我本人能力有限,菜的很,所以这个工具若是对您有用,并且您有了新的点子,同样欢迎提交您的合并请求,我会认真阅读,并维护好项目。

开源地址

https://github.com/CBDlkl/AspnetCoreApiDoc

Nuget下载

关于ProtoBuffer

官方描述:

Protocol buffers are a language-neutral, platform-neutral extensible mechanism for serializing structured data.

生成文档示例

说明文档

NO.1

引用项目后,在中的方法加入如下代码,进行服务注册:

NO.2

在方法启用服务:

NO.3

在需要生成API文档的控制器方法上添加特性标记

例如:

上添加:

上添加:

在controller上添加ApiDoc特性后,可以在该控制器下的action上再添加来停止某个单独方法的文档生成

NO.4

给API的项目和所有其依赖的项目的文件中的节点下都加上生成XML的配置,如下:

完整实例:

约定

所有API的方法传入参数必须从Body中读取

版权

本项目采用 MIT 开源授权许可证

原文地址: https://www.cnblogs.com/likeli/p/8204054.html

  • 发表于:
  • 原文链接:http://kuaibao.qq.com/s/20180107B02PM300?refer=cp_1026

扫码关注云+社区