https://www.showdoc.cc/里面有详细示例。这是一个免费开源的用于维护API文档的工具。能提供在线托管或者部署保存到本地的服务。
一把部署到本地的时候，会安装Docker容器。Docker是一个开源的应用容器引擎。
一个完整的API文档一般包含以下几个部分：
（1）、接口名称；
（2）、简要描述；
（3）、请求的URL；
（4）、请求方式（get/post等）；
（5）、请求参数（参数名、是否必选、参数类型、说明）；
（6）、返回示例；
（7）、返回参数说明（参数名、类型、说明）；
（8）、备注及责任人；
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
参考网址：https://www.showdoc.cc/storm123
