10.4. API 文档

API 文档

完成了所有的 API 及测试,我们需要有个一份接口文档,方便他人使用,这一节我们来介绍一下快速生成 API 文档的方法。

PostMan

PostMan 导出的 Collection 其实已经是一份基础的接口文档,可以进一步补充请求参数的描述信息。
file

当然也有很多缺点:

  • 需要通过导入导出来分享文档;
  • 没法对响应结果进行详细说明;
  • 没有地方添加关于当个接口的进一步说明;

当然了付费用户可以享受更多方便的功能,我们在这里不做进一步讨论。

Apizza 介绍

Apizza 是一款在线的 API 协作管理工具,界面及使用方式与 PostMan 基本类似,可以理解为一款在线版的 PostMan。

但是与 PostMan 相比,功能要更加的丰富,比如我们可以更加详细的定义请求参数和参数类型。
file

可以更加详细的描述响...

本文章首发在 LearnKu.com 网站上。

为了保证课程的高品质,我们需要对课程进行收费。付费后 才能观看剩余内容。 购买

上一篇 下一篇
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
讨论数量: 7

jake666
Laravel 有没有类似 swagger 的 API 文档工具
0 个点赞 | 1 个回复 | 问答 | 课程版本 5.5
putixin
将 posrman 环境变量导入 Apizza 会报错?
0 个点赞 | 1 个回复 | 问答 | 课程版本 5.5
kaen
一个用户的话题列表接口, 用户的 ID 在 Apizza 里, 如何配置?
0 个点赞 | 1 个回复 | 问答 | 课程版本 5.5
nbutluo
Apizza 是不是无法导入postman 中的环境变量
0 个点赞 | 0 个回复 | 分享 | 课程版本 7.x
惊风破浪
单元测试会什么报这个错误?
0 个点赞 | 0 个回复 | 分享 | 课程版本 6.x