ApiDocs 编写后台文档

简介

在开发后台 需要api的编写 那么在提供给web端和移动客户端的开发者时需要给他们提供必要的api文档 那么今天就来介绍

一个文档编写工具 apidocjs 整个语法还是遵循markdown的语法

当然apidoc支持Grunt，主页 https://github.com/apidoc/grunt-apidoc

其实这样类似的工具还有很多 但目的只有一个就是提供给其他开发者更好的说明 所以说文档的编写和规范都是十分重要的

安装

在命令行全局安装

$ npm install apidoc -g

apidoc支持Grunt，主页https://github.com/apidoc/grunt-apidoc

在项目中可以使用npm install grunt-apidoc --save-dev安装

添加grunt.loadNpmTasks('grunt-apidoc')到Gruntfile.js

添加grunt task 这里面包含了输出目录等信息

apidoc: {
      myapp: {
        src: "app/",
        dest: "apidoc/"