企业官网建设流程全解析

如何提高网站收录,wordpress 4.8.1下载,常州建设局官方网站,加快建设乡镇招商网站PostIn是一款开源免费的接口管理工具#xff0c;包含项目管理、接口调试、接口文档设计、接口数据MOCK等模块。IDEA插件可扫描代码自动生成接口文档并上传到PostIn系统。本文将详细介绍怎么安装IDEA插件#xff0c;使用插件上报接口并生成接口文档。 1、插件下载及安装 本节…PostIn是一款开源免费的接口管理工具包含项目管理、接口调试、接口文档设计、接口数据MOCK等模块。IDEA插件可扫描代码自动生成接口文档并上传到PostIn系统。本文将详细介绍怎么安装IDEA插件使用插件上报接口并生成接口文档。1、插件下载及安装本节将详细介绍 PostIn 插件下载、安装。方式1在 IntelliJ IDEA 中搜索并安装 PostIn 插件。打开 IDEA 设置进入 Plugins插件页面搜索 “PostIn” 并安装 “PostIn” 插件。安装插件方式2在 Jetbrains Marketplace 中下载后通过本地安装下载地址IDEA插件。打开 IDEA 设置进入 Plugins插件页面点击Installed右侧的设置按钮选择install plugin from disk... 从磁盘安装插件。注意插件仅支持 IntelliJ IDEA 2024.1.7 版本。本地安装插件安装结束后在idea右侧侧边栏显示PostIn。IDEA插件界面2、插件配置IDEA安装结束后要对插件进行配置。进入插件后显示扫描接口 上报接口设置三个按钮。功能说明配置PostIn插件点击“设置”按钮进入PostIn插件的配置。插件配置需要配置PostIn服务的URL注意配置的URL尾部不需要带/以及上报接口的所属空间ID上报接口的所属空间ID可以在PostIn空间详情。项目信息3、插件使用IDEA插件配置结束后使用插件之前需要对代码中的接口进行注释IDEA根据注释将接口上报到PostIn系统。3.1 添加代码注释首先需要在接口文件controller 中添加注释包含接口协议、导入接口文件夹名称、接口地址。/** * pi.protocol: http * pi.groupName: 空间关注 * pi.path:/workspaceFollow */● pi.protocol定义了接口的协议。● pi.groupName定义了接口的文件夹名称。● pi.path定义了该接口的基本 URL 路径。其次需要在接口前添加接口详细信息的注释包含接口名称、接口详细URL、请求方式、请求类型、请求参数。通过请求类型的不同可以分为两种。第一种模型/** * pi.name:创建空间关注123 * pi.url:/createWorkspaceFollow * pi.methodType:post * pi.request-type:json * pi.param: modelio.tiklab.postin.workspace.model.WorkspaceFollow */● pi.name定义了接口的名称。● pi.url和pi.path共同组成了接口的完整路径举例接口的完整路径/workspaceFollow/createWorkspaceFollow● pi.methodType定义了接口请求方式。● pi.request-type定义了接口请求类型。● pi.param请求参数内容。接口注释第二种字段/** * pi.name:删除空间关注123 * pi.url:/deleteWorkspaceFollow * pi.methodType:post * pi.request-type:formdata * pi.param: nameid;dataTypestring;valueworkspaceId;desc当前删除的id * pi.param: nameid2;dataTypestring;valueworkspaceId2;desc当前删除的id2 */● pi.name定义了接口的名称。● pi.url和pi.path共同组成了接口的完整路径举例接口的完整路径/workspaceFollow/deleteWorkspaceFollow● pi.methodType定义了接口请求方式。● pi.request-type定义了接口请求类型。● pi.param请求参数内容。接口注释3.2 扫描并上传API接口注释添加完成后在PostIn插件点击“扫描接口”按钮扫描当前项目所有接口。扫描接口扫描出接口后用户可单选、多选或全选接口后提交上报。例如接口总共有7个按Ctrl选择其中3个点击“上传接口”按钮系统弹出”确认上传接口“二次确认弹窗。上报确认点击“是”选择的接口上传到PostIn系统。成功上报3.2 更新API文档当接口进行更新之后还可以利用PostIn插件对接口进行更新。接口成功上传PostIn后对接口信息进行修改只要接口路径即pi.path和pi.url组成的路径未进行修改再次上传接口会对当前接口进行更新。更新接口接口路径即pi.path和pi.url组成的路径修改之后再次上传接口接口会按照新接口进行添加。上报成功之后可以在PostIn和 IntelliJ IDEA 环境信息对比。上报接口对比下图为请求为字段上报PostIn前后信息对比。上报接口对比