codecamp

api 文档生成

生成api文档基于 apidoc ,确保你已经提前安装好了 (npm install apidoc -g)

生成API文档

生成文档的操作我们可以在本地进行，完成后上传到服务器上

1.进入代码根目录，执行

api文档会默认在 root -> app -> public 目录下创建文件，由于 public 目录是默认的静态目录，所以发布后可以直接通过浏览器访问到

npm run makePrdDoc

2.上传api文档到服务器

3.通过你的域名域名访问Api文档

https://www.yourdomain.cn/static/apidoc/index.html

温馨提示

下载编程狮App，免费阅读超1000+编程语言教程

取消

确定

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }