电商管理后台api接口文档（API接口管理）

本文目录一览：

• 1、还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器

• 2、如何优雅的“编写”api接口文档

• 3、淘宝/天猫官方商品/订单订单API接口

还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器

作为一个前后端分离模式开发的团队，我们经常会看到这样的场景：前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了？”，“接口怎么又不通了？”，“稍等，我调试下”，“你再试试..."。

那能不能写好接口文档，大家都按文档来开发？很难，因为写文档、维护文档比较麻烦，而且费时，还会经常出现 API 更新了，但文档还是旧的，各种同步不一致的情况，从而耽搁彼此的时间。

之前我们团队也遇到了同样的问题，那么作为研发团队的负责人，我是如何带领团队解决这个问题的呢？

方法其实很简单，如果能做到让写文档/维护文档这件事情的短期收益就能远高于付出的成本，那么所有问题都能迎刃而解，开发人员就会非常乐意去写接口文档。

要做到写文档和及时维护文档的短期收益就能远高于付出的成本，无非两个方向：

鉴于此，我们设想如果有一款工具做到以下这些是不是就非常爽了？

总结下来，我们需要的就是这么一款工具：

为此，我们几乎尝遍了市面上所有相关的工具，但是很遗憾，没有找到合适的。

于是，我们自己实现了一个Postman + Swagger + RAP + JMeter

这个工具就是 Apifox，经常很长一段时间不断更新迭代后，我们基本上完全实现了最初的设想，几乎完美解决了最开始遇到的所有问题，在公司内部大受欢迎。并且也形成了我们自己的最佳实践。

没错，现在我们已经将Apifox产品化对外服务了，你们团队也可以直接使用Apifox了。

官网：

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。

通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好接口文档，接口调试、数据 Mock、接口测试就可以直接使用，无需再次定义；接口文档和接口开发调试使用同一个工具，接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确！

节省研发团队的每一分钟！

如果你认为 Apifox 只做了数据打通，来提升研发团队的效率，那就错了。Apifox 还做了非常多的创新，来提升开发人员的效率。

通常一个接口会有多种情况用例，比如 正确用例 参数错误用例 数据为空用例 不同数据状态用例。定义接口的时候定义好这些不同状态的用例，接口调试的时候直接运行，非常高效。

可以独立定义数据模型，接口定义时可以直接引用数据模型，数据模型之间也可以相互引用。同样的数据结构，只需要定义一次即可多处使用；修改的时候只需要修改一处，多处实时更新，避免不一致。

使用 Apifox 调试接口的时候，系统会根据接口文档里的定义，自动校验返回的数据结构是否正确，无需通过肉眼识别，也无需手动写断言脚本检测，非常高效！

Apifox 自动校验数据结构

设置断言：

Apifox 设置断言

运行后，查看断言结果：

先放一张图对比下 Apifox 和其他同类工具 零配置 mock 出来的数据效果：

Apifox Mock 数据结果对比同类工具

可以看出 Apifox 零配置 Mock 出来的数据和真实情况是非常接近的，前端开发可以直接使用，而无需再手动写 mock 规则。

「Apifox 如何做到高效率、零配置生成非常人性化的 mock 数据」

Apifox 项目可“在线分享” API 文档，分享出去的 API 文档可设置为公开或需要密码访问，非常方便与外部团队协作。

体验地址：

根据接口模型定义，自动生成各种语言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的业务代码（如 Model、Controller、单元测试代码等）和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。

更重要的是：你可以通过自定义代码模板来生成符合自己团队的架构规范的代码，满足各种个性化的需求。

接口调试

Apifox 多种主题色可选

如何优雅的“编写”api接口文档

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一、请求参数

1. 请求方法

GET

用于获取数据

POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

DELETE

用于删除数据

其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

application/x-www-form-urlencoded

请求参数使用“”符号连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：

二、响应参数

1. 响应 HTTP Body

响应body同请求body一样，需要描述请清除数据的类型。

另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。

三、接口说明

说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。

四、示例

上个示例（重点都用红笔圈出来，记牢了）：

五、接口工具

推荐使用的是（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

淘宝/天猫官方商品/订单订单API接口

测试网址：点击免费测试注册  -  跨境电商平台接口提供商 数据采集公司 数据接口定制服务 企业级数据服务商

商品接口列表产品管理包

Taobao.product.get 获取一个产品的信息  官方文档

Taobao.products.search 搜索产品信息  官方文档

Taobao.product.add 上传一个产品，不包括产品非主图和属性图片  官方文档

Taobao.product.img.upload 上传单张产品非主图，如果需要传多张，可调多次  官方文档

Taobao.product.propimg.upload 上传单张产品属性图片，如果需要传多张，可调多次  官方文档

Taobao.product.update 修改一个产品，可以修改主图，不能修改子图片  官方文档

Taobao.products.get 获取产品列表  官方文档

商品类目属性

Taobao.itempropvalues.get 获取标准类目属性值  官方文档

Taobao.itemprops.get 获取标准商品类目属性  官方文档

Taobao.itemcats.get 获取后台供卖家发布商品的标准商品类目  官方文档

店铺信息查询

Taobao.shopcats.list.get 获取前台展示的店铺类目  官方文档

Taobao.sellercats.list.get 获取前台展示的店铺内卖家自定义商品类目  官方文档

Taobao.shop.seller.get 卖家店铺基础信息查询  官方文档

店铺信息更新

Taobao.sellercats.list.add 添加卖家自定义类目  官方文档

Taobao.sellercats.list.update 更新卖家自定义类目  官方文档

Taobao.shop.update 更新店铺基本信息  官方文档

退款管理包

Taobao.refunds.apply.get 查询买家申请的退款列表  官方文档

Taobao.refunds.receive.get 查询卖家收到的退款列表  官方文档

Taobao.refund.get 获取单笔退款详情  官方文档

Taobao.refund.messages.get 查询退款留言/凭证列表  官方文档

Taobao.refund.message.add 创建退款留言/凭证  官方文档

Taobao.refund.refuse 卖家拒绝退款  官方文档

Schema商品发布

Tmall.item.schema.add 天猫根据规则发布商品  官方文档

Tmall.item.add.schema.get 天猫发布商品规则获取  官方文档

Tmall.product.add.schema.get 产品发布规则获取接口  官方文档

Tmall.product.match.schema.get 获取匹配产品规则  官方文档

Tmall.product.schema.match product匹配接口  官方文档

Tmall.product.schema.add 使用Schema文件发布一个产品  官方文档

Tmall.product.update.schema.get 产品更新规则获取接口  官方文档

Tmall.product.schema.update 产品更新接口  官方文档

Tmall.item.schema.update 天猫根据规则编辑商品  官方文档

Tmall.item.update.schema.get 天猫编辑商品规则获取  官方文档

Tmall.product.schema.get 产品信息获取schema获取  官方文档

Tmall.item.increment.update.schema.get 天猫增量更新商品规则获取  官方文档

Tmall.item.schema.increment.update 天猫根据规则增量更新商品  官方文档

Tmall.item.add.simpleschema.get 天猫发布商品规则获取  官方文档

Tmall.item.calculate.hscode.get 算法获取hscode  官方文档

Tmall.item.hscode.detail.get 通过hscode获取计量单位  官方文档

Tmall.item.hscode.audit.results.query 商品hscode信息审核状态查询接口  官方文档

商品价格更新

Taobao.item.price.update 更新商品价格  官方文档

Tmall.item.price.update 天猫商品/SKU价格更新接口  官方文档

商品上下架

Taobao.item.update.delisting 商品下架  官方文档

Taobao.item.update.listing 一口价商品上架  官方文档

卖家商品查询

Taobao.items.onsale.get 获取当前会话用户出售中的商品列表  官方文档

Taobao.item.sku.get 获取SKU  官方文档

Taobao.item.skus.get 根据商品ID列表获取SKU信息  官方文档

Taobao.itemcats.authorize.get 查询商家被授权品牌列表和类目列表  官方文档

Taobao.items.inventory.get 得到当前会话用户库存中的商品列表  官方文档

Taobao.items.custom.get 根据外部ID取商品  官方文档

Taobao.skus.custom.get 根据外部ID取商品SKU  官方文档

商品同步

Taobao.item.seller.get 获取单个商品详细信息  官方文档

Taobao.items.seller.list.get 批量获取商品详细信息  官方文档

商品编辑

Taobao.item.update 更新商品信息  官方文档

Taobao.item.add 添加一个商品  官方文档

Taobao.item.img.upload 添加商品图片  官方文档

Taobao.item.img.delete 删除商品图片  官方文档

Taobao.item.propimg.delete 删除属性图片  官方文档

Taobao.item.propimg.upload 添加或修改属性图片  官方文档

Taobao.item.sku.add 添加SKU  官方文档

Taobao.item.sku.update 更新SKU信息  官方文档

Taobao.item.delete 删除单条商品  官方文档

Taobao.item.joint.img 商品关联子图  官方文档

Taobao.item.joint.propimg 商品关联属性图  官方文档

Taobao.item.sku.delete 删除SKU  官方文档

Taobao.item.quantity.update 宝贝/SKU库存修改  官方文档

Taobao.item.templates.get 获取用户宝贝详情页模板名称  官方文档

Taobao.item.sku.price.update 更新商品SKU的价格  官方文档

Taobao.skus.quantity.update SKU库存修改  官方文档

Taobao.item.anchor.get 获取可用宝贝描述规范化模块  官方文档

Tmall.item.desc.modules.get 商品描述模块信息获取  官方文档

Taobao.item.barcode.update 更新商品条形码信息  官方文档

Tmall.item.sizemapping.templates.list 获取天猫商品尺码表模板列表  官方文档

Tmall.item.sizemapping.template.get 获取天猫商品尺码表模板  官方文档

Tmall.item.sizemapping.template.delete 删除天猫商品尺码表模板  官方文档

Tmall.item.sizemapping.template.update 更新天猫商品尺码表模板  官方文档

Tmall.item.sizemapping.template.create 新增天猫商品尺码表模板  官方文档

Tmall.item.outerid.update 天猫商品/SKU商家编码更新接口  官方文档

Tmall.item.shiptime.update 更新商品发货时间  官方文档

Tmall.item.simpleschema.add 天猫简化发布商品  官方文档

Tmall.item.simpleschema.update 天猫简化编辑商品  官方文档

Tmall.item.quantity.update 天猫商品/SKU库存更新接口  官方文档

卖家信息查询

Taobao.user.seller.get 查询卖家用户信息  官方文档

图片管理

Taobao.picture.category.get 获取图片分类信息  官方文档

Taobao.picture.get 获取图片信息  官方文档

Taobao.picture.delete 删除图片空间图片  官方文档

Taobao.picture.upload 上传单张图片  官方文档

Taobao.media.category.update 更新媒体文件分类  官方文档

Taobao.picture.category.add 新增图片分类信息  官方文档

Taobao.picture.category.update 更新图片分类  官方文档

Taobao.picture.replace 替换图片  官方文档

Taobao.picture.update 修改图片名字  官方文档

Taobao.picture.userinfo.get 查询图片空间用户的信息  官方文档

Taobao.picture.isreferenced.get 图片是否被引用  官方文档

Taobao.picture.pictures.get 图片获取  官方文档

Taobao.picture.pictures.count 图片总数查询  官方文档

订单接口列表(新)物流管理包

Taobao.delivery.template.get 获取用户指定运费模板信息  官方文档

Taobao.delivery.templates.get 获取用户下所有模板  官方文档

Taobao.delivery.template.delete 删除运费模板  官方文档

Taobao.delivery.template.add 新增运费模板  官方文档

Taobao.delivery.template.update 修改运费模板  官方文档

Taobao.logistics.consign.resend 修改物流公司和运单号  官方文档

AG退款流程接入

Taobao.nextone.logistics.warehouse.update AG退货入仓状态写接口  官方文档

Taobao.rdc.aligenius.refunds.check 退款信息审核  官方文档

Taobao.rdc.aligenius.sendgoods.cancel 取消发货  官方文档

Taobao.rdc.aligenius.account.validate AG商家账号校验  官方文档

Taobao.rdc.aligenius.warehouse.resend.logistics.msg.post 补发单物流信息回传  官方文档

Taobao.rdc.aligenius.warehouse.resend.update 补发单状态回传  官方文档

Taobao.rdc.aligenius.ordermsg.update 订单消息状态回传  官方文档

Taobao.rdc.aligenius.warehouse.reverse.event.update 销退单事件回传接口  官方文档

Taobao.rdc.aligenius.warehouse.reverse.uploading 销退单上传  官方文档

Taobao.rdc.aligenius.identification.case.result.update 鉴定工单结果同步  官方文档

Taobao.rdc.aligenius.identification.case.update 鉴定工单信息同步  官方文档

物流基础信息查询

Taobao.areas.get 查询地址区域  官方文档

Taobao.logistics.companies.get 查询物流公司信息  官方文档

Taobao.logistics.partners.get 查询支持起始地到目的地范围的物流公司  官方文档

卖家地址库管理

Taobao.logistics.address.search 查询卖家地址库  官方文档

Taobao.logistics.address.remove 删除卖家地址库  官方文档

Taobao.logistics.address.modify 卖家地址库修改  官方文档

Taobao.logistics.address.add 卖家地址库新增接口  官方文档

Taobao.logistics.address.reachable 判定服务是否可达  官方文档

Taobao.logistics.address.reachablebatch.get 批量判定服务是否可达  官方文档

商品类目属性

Taobao.itempropvalues.get 获取标准类目属性值  官方文档

Taobao.itemprops.get 获取标准商品类目属性  官方文档

Taobao.itemcats.get 获取后台供卖家发布商品的标准商品类目  官方文档

获取单笔交易信息

Taobao.trade.get 获取单笔交易的部分信息(性能高)  官方文档

退款管理包

Taobao.refunds.apply.get 查询买家申请的退款列表  官方文档

Taobao.refunds.receive.get 查询卖家收到的退款列表  官方文档

Taobao.refund.get 获取单笔退款详情  官方文档

Taobao.refund.messages.get 查询退款留言/凭证列表  官方文档

Taobao.refund.message.add 创建退款留言/凭证  官方文档

Taobao.refund.refuse 卖家拒绝退款  官方文档

物流订单查询

Taobao.logistics.orders.detail.get 批量查询物流订单,返回详细信息  官方文档

Taobao.logistics.orders.get 批量查询物流订单  官方文档

Taobao.logistics.trace.search 物流流转信息查询  官方文档

Taobao.wlb.order.jz.query 家装业务查询物流公司api  官方文档

Taobao.wlb.order.jz.consign 家装发货接口  官方文档

物流发货

Taobao.logistics.online.send 在线订单发货处理（支持货到付款）  官方文档

Taobao.logistics.online.cancel 取消物流订单接口  官方文档

Taobao.logistics.online.confirm 确认发货通知接口  官方文档

Taobao.logistics.offline.send 自己联系物流（线下物流）发货  官方文档

Taobao.logistics.dummy.send 无需物流（虚拟）发货处理  官方文档

Taobao.logistics.order.create 创建物流订单  官方文档

Taobao.logistics.consign.order.createandsend 创建订单并发货  官方文档

Taobao.wlb.stores.baseinfo.get 商家按照仓的类型获取仓库接口  官方文档

Taobao.logistics.consign.tc.confirm 通知交易确认发货接口  官方文档

Cainiao.nbadd.appointdeliver.getconsigninfo 获取支持定时派送服务发货信息  官方文档

订单编辑

Taobao.trade.memo.add 对一笔交易添加备注  官方文档

Taobao.trade.memo.update 修改交易备注  官方文档

Taobao.trade.ordersku.update 更新交易的销售属性  官方文档

Taobao.trade.shippingaddress.update 更改交易的收货地址  官方文档

Taobao.trade.receivetime.delay 延长交易收货时间  官方文档

Taobao.trade.postage.update 修改交易邮费价格  官方文档

订单信息查询

Taobao.trades.sold.get 查询卖家已卖出的交易数据（根据创建时间）  官方文档

Taobao.trade.fullinfo.get 获取单笔交易的详细信息  官方文档

Taobao.trades.sold.increment.get 查询卖家已卖出的增量交易数据（根据修改时间）  官方文档

Taobao.trade.confirmfee.get 获取交易确认收货费用  官方文档

Taobao.trade.amount.get 交易帐务查询  官方文档

Taobao.trades.sold.incrementv.get 查询卖家已卖出的增量交易数据（根据入库时间）  官方文档

退款退货

Taobao.rp.refunds.agree 同意退款  官方文档

Taobao.rp.returngoods.agree 卖家同意退货  官方文档

Taobao.rp.refund.review 审核退款单  官方文档

Taobao.rp.returngoods.refill 卖家回填物流信息  官方文档

Taobao.rp.returngoods.refuse 卖家拒绝退货  官方文档

Taobao.refund.refusereason.get 获取拒绝原因列表  官方文档

Tmall.dispute.receive.get 天猫逆向纠纷查询  官方文档

评价信息更新

Taobao.traderate.add 新增单个评价  官方文档

Taobao.traderate.list.add 针对父子订单新增批量评价  官方文档

Taobao.traderate.explain.add 商城评价解释接口  官方文档

评价信息查询

Taobao.traderates.get 搜索评价信息  官方文档

Taobao.traderate.impr.imprwords.get 评价大家印象印象短语接口  官方文档

Tmall.traderate.feeds.get 查询子订单对应的评价、追评以及语义标签  官方文档

Tmall.traderate.itemtags.get 通过商品ID获取标签列表  官方文档

电子面单

Taobao.wlb.waybill.i.get 获取物流服务商电子面单号v1.0  官方文档

Taobao.wlb.waybill.i.search 查询面单服务订购及面单使用情况v1.0  官方文档

Taobao.wlb.waybill.i.fullupdate 面单信息更新接口v1.0  官方文档

Taobao.wlb.waybill.i.print 打印确认接口v1.0  官方文档

Taobao.wlb.waybill.i.querydetail 查面单号状态v1.0

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。