源文件 https://files.cnblogs.com/files/bincoding/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3.zip 目录 测试接口 查询指定项目属性** 接口功能 获取制定项目的分类信息 接口地址 https://www.bincoding.cn/test HTTP请求方式 POST JSON 请求参数 参数 必选 类型 说明 name ture string 请求内容1 type true int 请求内容2 返回字段 返回字段 字段类

上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown基本语法也没啥好说的,随便百度一下几分钟看懂基本的,20%的知识完成80%的任务嘛,够了. 关键在于,我有些特殊需求,以方便将Markdown作为接口文档查看.什么需求呢? 目录.这是重中之重.没有方便的TOC的话,文档长了,查看起来真是费劲.我理想中的目录是这样的: 根据H1(# ).H2(## 

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出

效果 目录 1. 查询指定项目属性接口 1. 查询指定项目属性 接口功能 获取制定项目的分类信息 URL http://www.api.com/index.php 支持格式 JSON HTTP请求方式 GET 请求参数 > 参数 必选 类型 name ture string 请求的项目名 type true int 请求项目的类型.1:类型一:2:类型二 . 返回字段 > 返回字段 字段类型 status int 返回结果状态.0:正常:1:错误. company string 所属公司名 c

接口名称 1) 请求地址 https://apis.cnblogs.com/user/info?a=xx&b=xx 2) 调用方式:HTTP GET 3) 接口描述: 接口描述详情 4) 请求参数: GET参数: 字段名称 字段说明 类型 必填 备注 a string Y - b string Y - 5) 请求返回结果: { "errNum": 10001, "errMsg": "Param error" } 6) 请求返回结果参数说明

https://blog.csdn.net/s390124971/article/details/51995497

书接上一回,小白和老菜聊到代码的版本控制和接口文档 小白:为什么要做版本控制,我不弄版本控制不也完成了项目了吗?要做版本控制不是很麻烦,又要安装服务又要提交代码,代码又不是多人用开发,还要写文档...... 老菜:这就是你这些小白的思维,只看眼前不思长远.对于任何一个项目,你都不可能绝对的说它永远都是一个小项目:而项目完成后,同时也面临着不停的变更与修改,你不可能永远记得这个项目任何细节,随着时间的流逝,很多关键点与细节在你的记忆中就会变得越来越模糊,到时要重新修改时你就头大了.我之前有位同事,

2017年9月18日 19:20:22 星期一 因工作需要, 用PHP写了一个管理接口文档的小工具, 下边介绍一下: 浏览器展示的效果: 项目地址:(码云) 例子(http://doc.hearu.top/) 项目模块说明: 左侧目录树: dtree.js  不依赖其他js Markdown转html: segmentfault社区开发的PHP工具 parsedown  (一个国外的PHP类) 遍历md文件生成左侧目录树所需的数据: 利用树的后根序遍历算法读取文件夹的PHP类(自己开发, 暂未发

写在前面: 将进行3个步骤配置 1.在sublime3中安装插件docblockr,可以参考http://www.cnblogs.com/jiangxiaobo/p/8327709.html 2.安装之后在首选项中选取插件设置,找到DocBlockr插件,进行User Setting 3.配置DocBlockr,配置代码如下: { // 自定义配置,不建议在默认配置里进行更改,应该在User Settings里进行单独配置 "jsdocs_extra_tags" : [ // apid

Python之word文档模板套用: 1 ''' 2 #word模板套用2:套用模板 3 ''' 4 5 #导入所需库 6 from docx import Document 7 ''' 8 #另存word文档后格式丢失的问题要导入库设定word文档的初始格式 9 from docx.shared import Pt 10 from docx.oxml.ns import qn 11 ''' 12 13 #导入模板文档 14 document = Document('D:/路径/模板.docx'