其他分享
首页 > 其他分享> > 09_项目API文档

09_项目API文档

作者:互联网

一,怎么写API文档:

1)API文档其实描述项目中的功能,现在建议遵守RESTful风格
2)描述性文本尽量占到50%以及以上
3)格式清晰,规范,风格统一
4)业务逻辑设计时,全面,合理

写的好的标准:大家都读得懂,给个小白看也能看懂
三要素:URL,提交的数据,响应的数据

标签:09,50%,API,文档,RESTful,逻辑设计
来源: https://blog.csdn.net/paidaxing_dashu/article/details/88789125