zhangxm0116的博客

转载 写接口文档的一些注意事项

转载文章，原文如下： 下面总结一下写文档需要注意事项： 1）封皮 封面最好是本公司规定的封面，有logo，内容标题，版本号，公司名称，文档产生日期。（错误地方在于，文档的标题要和页眉中的标题一致） 2）修订历史 表格形式较好些。包括，版本，修订说明，修订日期，修订人，审核时间审核人。（我错误的地方在于，表格中其他空白表格没有居中） 3）接口信息 接口调用方式，是post方式还是get方式，接口地址...