检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。
正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,详细操作可参照API设计章节。 单击“调试”页签进入调试页面,详细操作可参照示例接口调试。
单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,操作可参照API设计章节。 单击“调试”页签进入调试页面,操作可参照示例接口调试。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
url、domain、email、ip、tld。 Address region、province、city、county。 Text paragraph、sentence、word、title、cparagraph、csentence、cword、ctitle。 Color color。 Other guid, id
mockjs:模拟数据生成,拦截Ajax请求。 csv-parse/lib/sync( v1.2.4):处理CSV格式数据。 iconv-lite:用于字符编码转换,支持数十种字符编码格式的转换。 内置NodeJS模块 path:处理文件路径。 assert:提供一组断言测试。 buffer:处理二进制数据。 util:实用函数的集合。
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
url、domain、email、ip、tld。 Address region、province、city、county。 Text paragraph、sentence、word、title、cparagraph、csentence、cword、ctitle。 Color color。 Other guid, id
API文档 API设计完成后,单击“保存”,会自动跳转到API文档页面。如果单击左侧导航栏中的API,默认进入API文档页面。 API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,
API文档 API设计完成后,单击“保存”,会自动跳转到API文档页面。如果单击左侧导航栏中的API,默认进入API文档页面。 API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,
mockjs:模拟数据生成,拦截Ajax请求。 csv-parse/lib/sync( v1.2.4):处理CSV格式数据。 iconv-lite:用于字符编码转换,支持数十种字符编码格式的转换。 内置NodeJS模块 path:处理文件路径。 assert:提供一组断言测试。 buffer:处理二进制数据。 util:实用函数的集合。
API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。
API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。
功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。 API测试
功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。 API测试
OS支持 更新内容 发布时间 2.2.0 Windows X86 新特性: 支持上海一region;API设计模块支持导出html格式接口文档; 项目设置模块导入数据列表支持搜索和排序; 修复: 修复其他已知问题。 2025-01-06 2.1.3 Windows X86 新特性: