【IT修真院】接口文档规范以及示例

概述

所有项目接口文档，麻烦上心整理，文档不是给自己看的，只有自己才看得懂的文档就不要放上去浪费其他同学的时间了。

所有文档至少包含以下信息：

1.接口功能
2.接口路径
3.接口入参
4.接口出参
5.各字段说明、约定值、是否必填、默认参数
6.复杂数据结构给出出范例

内容比较多，长期保持迭代的项目可将文档按照功能模块拆分

示例：

命名
1. 所有接口均需符合restful命名风格，相关api设计规则可参考阮一峰-RESTful API 设计指南文章
校验
1. 所有接口需日志记录关键入参，并对相关入参做好相关检验，参数缺失、异常必须给出异常码以及对应异常信息，方便查错。
2. 发送短信、语音，身份验证等收费接口，做好安全校验（加密或加图形验证码等），避免机器恶意的接口调用造成经济损失
3. 所有需要关于当前用户数据的相关操作，登录用户信息由后端直接从session、cookie、token中获取，禁止由前端进行传递。
设计
1. 从性能考虑，原则上后端接口中不对数据进行复杂处理，仅将相关业务数据返回即可，故非特殊情况，不写复杂数据处理逻辑。

【IT修真院】接口文档规范以及示例相关推荐

Swagger3 API接口文档规范课程（Java1234）（内含教学视频+源代码）
Swagger3 API接口文档规范课程(Java1234)(内含教学视频+源代码) 教学视频+源代码下载链接地址:https://download.csdn.net/download/weixin_ ...
算法API接口文档规范
算法API接口文档规范参考:百度AI开放平台:https://ai.baidu.com/ai-doc/FACE/yk37c1u4t 接口功能介绍 1.人脸比对:比对两张图片中人脸的相似度,并返回相似 ...
Popular MVC框架swagger+knif4j接口文档工具使用示例
Popular MVC框架swagger接口文档工具使用示例简介此项目介绍如何使用popularmvc内置的swagger+knife4j实现简单易用的实时API文档,支持在线调试接口! 此项目只 ...
开发者必备工具，一键生成接口文档、调用示例
前言开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档. 那要怎么快速的出接口文档.调用示例.mock呢?如果太麻烦,很多人就不愿意去写了. 今天给大家介绍一个 ...
开发必备工具，快速生成接口文档、调用示例、mock配置
前言开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档. 那要怎么快速的出接口文档.调用示例.mock呢?如果太麻烦,很多人就不愿意去写了. 今天给大家介绍一个 ...
RESTful API接口文档规范小坑
希望给你3-5分钟的碎片化学习,可能是坐地铁.等公交,积少成多,水滴石穿,谢谢关注. 前后端分离的开发模式,假如使用的是基于RESTful API的七层通讯协议,在联调的时候,如何避免配合过程中出现问 ...
接口文档规范有哪些？
接口测试的依据,往往不是需求文档,而是接口文档. 那么,接口文档的准确性便至关重要,本文推荐apipost接口文档生成工具生成的接口文档,供大家参考. 接口文档不管以什么形式存在,需要包含的内容有: ...
java对外发布接口文档_java之接口文档规范
一.xxxxxx获取指定任务爬取的所有url的接口接口名称:xxxxxx获取指定任务爬取的所有url的接口访问链接: http://IP:PORT/crwalTask/findUrlExcepti ...
Spring Boot 1.5.10项目引入knife4j接口文档
介绍 knife4j是一个在线接口文档项目,对swaggger2进行增强,页面更加美观,功能更加强大背景在前后端分离的趋势下,团队一直没有接口文档规范,联调接口全凭一个个接口去代码里扒,后端同事忙 ...

【IT修真院】接口文档规范以及示例

概述

命名

校验

设计

【IT修真院】接口文档规范以及示例相关推荐

最新文章

热门文章