全部 ApiPost使用 后端 前端 接口测试 IOS Android 数据库 2022 测试技术 工具
问答 / 问答详情

[已处理] 如何才能生成国内实用的接口规范文档(第三方)

ApiPost使用 94次浏览

1、我想要的接口规范文档包括的内容

a.接口说明:接口方式、报文格式(请求头、应答头)、加解密规则

b.接口清单(期望apipost完成)

c.接口详细设计(期望apipost完成)

1.接口名

入口参数:

出口参数:(apipost目前实现得不好)

调用示例:

应答示例:

d.数据字典(期望apipost完成)

| 0 收藏

4 个回答

非常感谢楼上回答,告诉我apipost可以生成接口文档

我更想要上述问题描述的格式接口文档,另还可以追加两点:

1.修订记录

2.发布对象不同时,选择不同接口,形成不同接口清单和接口明细。

修改记录在客户端版本管理查看   文档不体现
不同接口可以用接口用例实现 也是在客户端 文档不体现


期望将我的问题转交apipost开发设计人员,谢谢!

Apipost 私有化火热进行中

撰写答案

只服务于

前后端、移动端、测试人员

提问题 发布您遇到的Bug和问题,上万名大牛和开发者来帮您解决!