山东做网站公司哪家好,易名中国网站,数据分析师培训,o2o网站建设咨询1. 创建项目2. 获取api_key和api_token1. 打开设置2. 获取api_key和token3. 生成文档1. 先cd进入你的项目目录#xff0c;命令行模式下输入#xff1a;wget https://www.showdoc.cc/script/showdoc_api.sh下载完毕#xff0c;编辑vi showdoc_api.sh脚本内容的前面有两个变量…1. 创建项目2. 获取api_key和api_token1. 打开设置2. 获取api_key和token3. 生成文档1. 先cd进入你的项目目录命令行模式下输入wget https://www.showdoc.cc/script/showdoc_api.sh下载完毕编辑vi showdoc_api.sh脚本内容的前面有两个变量api_key 和 api_token 这个需要用户自行填写。关于这两个变量的取值请登录showdoc进入某个项目的设置点击开放API便可以看到说明。showdoc_api.sh生成的文档会放进你填写的这个项目里。除了api_key 和 api_token 还有一个url变量。如果是使用www.showdoc.cc 则不需要修改。如果是使用开源版showdoc则需要将地址改为http://xx.com/server/index.php?s/api/open/fromComments 其中别忘记了url里含server目录。保存文件后。执行以下命令脚本会自动递归扫描本目录和子目录的所有文本代码文件并生成API文档。chmod x showdoc_api.sh./showdoc_api.sh3. 文档注释规范想要生成文档需要按照规范进行注释示例/*** showdoc* catalog 测试文档/用户相关* title 用户登录* description 用户登录的接口* method get* url https://www.showdoc.cc/home/user/login* header token 可选 string 设备token* param username 必选 string 用户名* param password 必选 string 密码* param name 可选 string 用户昵称* return {error_code:0,data:{uid:1,username:12154545,name:吴系挂,groupid:2,reg_time:1436864169,last_login_time:0}}* return_param groupid int 用户组id* return_param name string 用户昵称* remark 这里是备注信息* number 99*/以上示例显示效果如下关键字关键字说明catalog生成文档要放到哪个目录。如果只是二级目录则直接写目录名字。如果是三级目录而需要写二级目录/三级目录即用/隔开。如”一层/二层/三层”title表示生成的文档标题description是文档内容中对接口的描述信息method接口请求方式。一般是get或者posturl接口URL。不要在URL中使用符号来传递参数。传递参数请写在参数表格中header可选。header说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。param参数表格说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。json_param可选。当请求参数是json的时候可增加此标签。请把json内容压缩在同一行内。return返回内容。请把返回内容压缩在同一行内。如果是json程序会自动进行格式化展示。 如果是非json内容则原样展示。return_param返回参数的表格说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。remark备注信息number可选。文档的序号。
