聊一聊：你碰到过哪些操蛋的文档？
发布日期：2021-06-29 22:01:57
浏览次数：2
分类：技术文章
本文共 360 字，大约阅读时间需要 1 分钟。
我们一直强调，要写注释，要写文档！
写出一份好文档是一个开发者应该具备的一项重要能力！
今天在群里（），看到一个经典的来自某国企的接口文档，引发了一段时间的讨论。
在这个文档中，HTTP接口的内容格式大致是这样的：
请求路径：/api/user
请求参数：
| 参数 | 必填 | 默认值 | 含义 | 示例 |
| name | 是 | 无 | 名称 | didi |
| address | 是 | 无 | 地址 | 上海xxx |
| age | 是 | 无 | 年龄 | |
| gender | 是 | 无 | 性别 | |
| birth | 是 | 无 | 生日 | 19900101 |
| graduate | 是 | 无 | 毕业院校 | |
| phone | 是 | 无 | 电话 | |
| native | 是 | 无 | 籍贯 |
聪明的你，有发现什么不妥么？
这样的文档群友们打了0分，你觉得可以得几分呢？
留言说说你觉得这样的接口文档问题在哪里呢？
你还碰到过哪些让你想口吐芬芳的文档呢？
往期推荐
转载地址：https://didispace-wx.blog.csdn.net/article/details/113361440 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！
发表评论
最新留言
路过按个爪印，很不错，赞一个！
[***.219.124.196]2024年04月12日 10时04分45秒
关于作者
喝酒易醉，品茶养心，人生如梦，品茶悟道，何以解忧？唯有杜康！
-- 愿君每日到此一游！
推荐文章
药品查询网的数据库
2019-04-30
python 下载pubmed数据
2019-04-30
MySql数据库备份的几种方式
2019-04-30
简化版拼音反查单元
2019-04-30
Sqlserver清理缓存和内存
2019-04-30
HIS（LIS、PACS、RIS、EMR）系统解决方案
2019-04-30
批量将DICOM文件转换为JPG图像（多进程、高效率）
2019-04-30
常用+SQL+语句大全
2019-04-30
常用经典SQL语句大全完整版
2019-04-30
PB DataWindow 38个技巧
2019-04-30
pb中操作excel表格函数
2019-04-30
12个用一条语句写成的有关日期函数
2019-04-30
ERP常用词汇
2019-04-30
PB对excel的操作
2019-04-30
一、数组函数
2019-04-30
二、Blob（大二进制对象）函数
2019-04-30
三、数据类型检查和转换函数
2019-04-30
四、日期、时间函数
2019-04-30
五、DDE客户函数
2019-04-30
发票信息批量提取到 excel 软件 2.3
2019-04-30
白红宇的个人博客 - 记录点点滴滴的事 - 您是第 310456494 位访客
访问时间: 2024-05-03 23:45:33
访问IP: 18.221.165.246
Copyright © 2020 - 2023 blog.css8.cn 京ICP备2021015314号-1
手机版