码迷,mamicode.com
首页 > Windows程序 > 详细

浅谈apidoc的使用

时间:2019-09-24 21:37:28      阅读:127      评论:0      收藏:0      [点我收藏+]

标签:json   根目录   运行   浅谈   使用   代码   code   信息   googl   

使用前提:服务器已经安装好apidoc了

1.项目根目录建立 apidoc.json ,文件基础信息如下

{
  "name": "项目名称",
  "version": "这里是版本好",
  "description": "项目接口文档"
}

2.代码中的注释严格按照apidoc的规则来

官方示例    搜索一下

3.运行命令以生成接口文档

apidoc -i ../api/ -o ./apidoc/
命令解释:
-i    后面的参数是需要生成接口文档的模块对于当前文件( apidoc.json )的相对路径
-o    后面的参数是生成的接口文档存放的文件夹,无需更改

4.访问生成的接口文档

域名/apidoc

 

浅谈apidoc的使用

标签:json   根目录   运行   浅谈   使用   代码   code   信息   googl   

原文地址:https://www.cnblogs.com/yulongcode/p/11580909.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!