ChatGPT生成接口文档实践案例(一)

ops/2024/12/27 7:06:31/

     生成接口文档的方法有很多,如研发人员手工编写或通过Swagger、Postman、Apiary、ChatGPT自动生成。在此仅针对利用ChatGPT生成接口文档的方法进行介绍,其他两种方法不赘述。

       以飞机订票系统的用户注册功能为例,其用户注册的界面如图5-9所示。

图5-9  用户注册的界面

  • 准备关键信息

        在本案例中,笔者准备的接口关键信息如下所示。

接口名称:用户注册接口

接口描述:新用户注册接口,注册内容包括:用户名、姓名、地址、邮编等。

请求地址:http://127.0.0.1:1080/cgi-bin/login.pl

请求方式:POST

请求体参数:

username         必填  用户名

password         必填  密码

passwordConfirm  必填  确认密码

firstName         选填  名字

lastName          选填 姓氏

address1          选填 街道地址

address2          选填 城市邮编

register.x        选填 注册x坐标

register.y        选填  注册y坐标

响应示例:HTML格式页面,注册成功 显示 Thank you, <b>{username}</b>

  • ChatGPT生成接口文档

        关键信息输入完成以后,就可以让ChatGPT生成用户接口文档,如图5-10所示。

图5-10  ChatGPT生成的用户注册接口文档

       ChatGPT给出两个方案供我们选择,即Response 1和Response 2,分别如图5-11和图5-12所示。

图5-11  ChatGPT生成的Response 1接口文档(部分)

    以下内容为ChatGPT生成的Response 1接口文档。

ChatGPT生成的Response 1接口文档

以下是飞机订票系统的用户注册接口文档:

用户注册接口

接口描述: 新用户注册接口,允许用户提供以下信息进行注册:用户名、密码、确认密码、名字、姓氏、街道地址、城市邮编。

请求地址: http://127.0.0.1:1080/cgi-bin/login.pl

请求方式: POST

请求体参数:

参数名

是否必填

描述

username

必填

用户名

password

必填

密码

passwordConfirm

必填

确认密码

firstName

选填

名字

lastName

选填

姓氏

address1

选填

街道地址

address2

选填

城市邮编

register.x

选填

注册x坐标

register.y

选填

注册y坐标

请求示例:

POST http://127.0.0.1:1080/cgi-bin/login.pl

Body:

{

  "username": "sample_user"

  "password": "password123"

  "passwordConfirm": "password123"

  "firstName": "John"

  "lastName": "Doe"

  "address1": "123 Main St"

  "address2": "City Zip Code"

  "register.x": "100"

  "register.y": "200"

}

响应示例:

如果注册成功,服务器将返回一个HTML格式的页面,显示以下内容:

Thank you <b>sample_user</b>

如果注册失败,服务器应该返回相应的错误信息,例如用户名已被占用或密码不匹配等信息。

图5-12  ChatGPT生成的Response 2接口文档(部分)

    以下内容为ChatGPT生成的Response 2接口文档。

ChatGPT生成的Response 2接口文档

以下是用户注册接口的接口文档:

用户注册接口

接口描述

新用户注册接口,用户可以通过此接口进行注册。注册信息包括用户名、密码、确认密码、名字、姓氏、街道地址和城市邮编等。

请求地址

POST http://127.0.0.1:1080/cgi-bin/login.pl

请求方式

POST

请求体参数

参数名

必填

类型

描述

username

必填

字符串

用户名

password

必填

字符串

密码

passwordConfirm

必填

字符串

确认密码

firstName

选填

字符串

名字

lastName

选填

字符串

姓氏

address1

选填

字符串

街道地址

address2

选填

字符串

城市邮编

register.x

选填

浮点数

注册x坐标

register.y

选填

浮点数

注册y坐标

响应示例

注册成功后,服务器将返回一个HTML格式的页面,显示感谢消息,其中{username}将被替换为实际注册的用户名。

Thank you <b>{username}</b>

错误响应示例

如果注册过程中发生错误,服务器可能返回相应的错误信息,如用户名已存在、密码不匹配等。

Registration failed. Please check your input and try again.

这是用户注册接口的接口文档,您可以使用这些信息来设计和实现相应的功能。希望这对您有所帮助!

       不难发现,两个方案都出色地完成了接口文档的生成,但笔者更喜欢Response 2的表达,因为其描述更加全面。


http://www.ppmy.cn/ops/145312.html

相关文章

08. 基于docker-compose部署LNMP架构

目录 前言 1、docker 1.1 任务要求 1.2 关闭防火墙 1.3 安装docker 1.4 配置镜像加速下载 2、Nginx 2.1 建立工作目录并进行相关操作 2.2 准备 nginx.conf 配置文件 3、Mysql 3.1 建立工作目录并进行相关操作 3.2 编写 my.cnf 配置文件 4、PHP 4.1 建立工作目录并…

Electron -- ipcMain 和 ipcRenderer的 区别(五)

ipcMain 和 ipcRenderer 是 Electron 中用于进程间通信&#xff08;IPC&#xff09;的两个不同的模块&#xff0c;它们分别运行在不同的进程中&#xff0c;并且有不同的用途&#xff1a; ipcMain ipcMain 是在主进程中使用的模块。它用于监听渲染进程&#xff08;或其他主进程…

【c语言】一维数组与二维数组

数组 数组名代表的是数组在内存中的起始位置&#xff0c;即首元素的地址&#xff0c;而下表表示的则是该元素相对数组起始位置的偏移量 一维数组 1.定义 类型名 数组名[数组长度] int a[100]; //整型数组长度为101&#xff0c;数组名为a char b[100];//字符型数组长度为101&…

C++设计模式:享元模式 (附文字处理系统中的字符对象案例)

什么是享元模式&#xff1f; 享元模式是一个非常实用的结构型设计模式&#xff0c;它的主要目的是节省内存&#xff0c;尤其在需要创建大量相似对象时。 通俗解释&#xff1a; 想象我们在写一本书&#xff0c;每个字母都需要表示出来。如果每个字母都单独用对象表示&#xff…

在Nginx部署Web应用,如何保障后端API的安全

1. 使用HTTPS和http2.0 参考&#xff1a;Nginx配置HTTP2.0_nginx 支持 2.0-CSDN博客 2. 设置严格的CORS策略 通过add_header指令设置CORS头。 只允许来自https://frontend.yourdomain.com的请求访问API location /api/ {if ($http_origin ~* (https://frontend\.yourdomai…

存储块的删除与状态查询

目录 存储块的删除 设计实现 存储块的删除 仅需删除任务列表的所有任务&#xff0c;无需在意空闲存储块。 设计实现 存储块的删除&#xff08;清空过程中可能有任务就绪&#xff0c;需执行一次调度&#xff09;存储块的状态查询&#xff08;当前存储块的计数、允许的最大计数、…

报表工具DevExpress Reporting v24.2亮点 - AI功能进一步强化

DevExpress Reporting是.NET Framework下功能完善的报表平台&#xff0c;它附带了易于使用的Visual Studio报表设计器和丰富的报表控件集&#xff0c;包括数据透视表、图表&#xff0c;因此您可以构建无与伦比、信息清晰的报表。 报表工具DevExpress Reporting v24.2将于近期发…

基于矩阵乘积态的生成模型:量子力学与生成任务的结合

&#x1f3e1;作者主页&#xff1a;点击&#xff01; &#x1f916;编程探索专栏&#xff1a;点击&#xff01; ⏰️创作时间&#xff1a;2024年12月23日11点02分 神秘男子影, 秘而不宣藏。 泣意深不见, 男子自持重, 子夜独自沉。 文章源链接(有视频)&#xff1a;Aspir…