postman——入门基础——接口文档示例以及接口文档系统

不念不忘少年蓝@ 2023-10-02 08:38 12阅读 0赞

[https://www.showdoc.cc/][https_www.showdoc.cc]里面有详细示例。这是一个免费开源的用于维护API文档的工具。能提供在线托管或者部署保存到本地的服务。

一把部署到本地的时候，会安装Docker容器。Docker是一个开源的应用容器引擎。

一个完整的API文档一般包含以下几个部分：

(1)、接口名称；

(2)、简要描述；

(3)、请求的URL；

(4)、请求方式(get/post等)；

(5)、请求参数(参数名、是否必选、参数类型、说明)；

(6)、返回示例；

(7)、返回参数说明(参数名、类型、说明)；

(8)、备注及责任人；

\------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

参考网址：[https://www.showdoc.cc/storm123][https_www.showdoc.cc_storm123]

![a79c1a75fa44d6fd84fb370ec12f87c8.png][]

![06dfa421501fc091a3dbcf2fb9b3a023.png][]

[https_www.showdoc.cc]: https://www.cnblogs.com/xiaobaibailongma/p/12124638.html
[https_www.showdoc.cc_storm123]: https://www.showdoc.cc/storm123
[a79c1a75fa44d6fd84fb370ec12f87c8.png]: https://img-blog.csdnimg.cn/img_convert/a79c1a75fa44d6fd84fb370ec12f87c8.png
[06dfa421501fc091a3dbcf2fb9b3a023.png]: https://img-blog.csdnimg.cn/img_convert/06dfa421501fc091a3dbcf2fb9b3a023.png

发表评论取消回复

表情：

评论列表（有 0 条评论，12人围观）

还没有评论，来说两句吧...

相关阅读

相关接口测试文档

个人项目 > v1.0.0 Base URLs: [本地测试: http://localhost:8081/ssm][http_localhost_8081_s

Love The Way You Lie/ 2023年10月14日 08:32/ 0 赞/ 43 阅读

相关 postman——入门基础——接口文档示例以及接口文档系统

[https://www.showdoc.cc/][https_www.showdoc.cc]里面有详细示例。这是一个免费开源的用于维护API文档的工具。能提供在线托管或者部署

不念不忘少年蓝@/ 2023年10月02日 08:38/ 0 赞/ 13 阅读

相关 postman——入门基础——接口测试流程

一、编写接口测试计划接口测试计划和功能测试计划目标一致，都是为了确认需求、确定测试环境、确定测试方法，为设计测试用例做准备，初步制定接口测试进度方案。一般来说，接口测试

墨蓝/ 2023年10月02日 08:38/ 0 赞/ 48 阅读

相关生成接口文档

Swagger生成接口文档，no no no JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情，对于后端程

比眉伴天荒/ 2022年12月04日 09:17/ 0 赞/ 377 阅读

相关接口文档笔记

文章目录版本变更记录接口列表接口1 接口编号+接口名称请求

朱雀/ 2022年10月22日 06:26/ 0 赞/ 356 阅读

相关接口文档管理工具-Postman、Swagger、RAP

在项目开发测试中，接口文档是贯穿始终的。前后端开发需要在开发前期进行接口定义并形成文档，QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试。接口文档往往以最简单的静

﹏ヽ暗。殇╰゛Y/ 2022年05月31日 01:28/ 0 赞/ 454 阅读

相关接口文档模板

获取用户信息开发者通过指定页数、每页显示条数，获取用户信息。接口调用请求说明 http请求方式: GET http://127.0.0.1:8080/Crazy

╰+攻爆jí腚メ/ 2022年05月24日 09:11/ 0 赞/ 386 阅读

相关 laravel接口接口文档

接口先在控制器里写一个接口的方法之所以写了两个方法因为写接口单独创建一个控制器比较好避免与页面展示冲突 // 展示页面配合城市接口执行 pu

太过爱你忘了你带给我的痛/ 2022年04月17日 01:59/ 0 赞/ 645 阅读

相关接口测试工具Postman和接口文档Swagger了解

接口测试工具Postman 什么是Postman 写完以后，前端以后不是我们写，就算是我们写也应该先测试好接口，才写前端。所以要先测试，对于get请求可以使用浏览器

朴灿烈づ我的快乐病毒、/ 2022年02月02日 04:55/ 0 赞/ 533 阅读

相关 postman项目接口文档和登录步骤原理

培训内容实训项目：非常果岭—发现模块接口测试，单接口、流程脚本编写；使用工具：postman 培训方式 1）postman使用说明 2）项目接口文档和登录步骤原理

Myth丶恋晨/ 2021年12月12日 02:34/ 0 赞/ 524 阅读