API Portal用户操作指导

举报
骑着蚂蚁撵火车 发表于 2023/11/02 16:53:13 2023/11/02
【摘要】 本文旨在帮助已开通白名单的API Portal体验用户创建API门户、创建云产品并完成API文档上架。 

本文旨在帮助已开通白名单的API Portal体验用户创建API门户、创建云产品并完成API文档上架。

 

如您的企业也有OpenAPI的诉求,请点击报名链接进行申请,工作人员将与您取得联系。报名点我>>

 

1      创建及编辑API门户

    1.1 点击全部门户中的“+


    1.1.png

    1.2 新建门户

        1.2.1 填写企业API门户名称(必填)。该名称将用于对外开放OpenAPI或在内部协作时展示,请您规范填写。例如填入您的企业简称或产品名称。

        1.2.2 填写门户描述。请对您的门户进行描述,例如您的产品能力、面向行业等内容。

        1.2.3 选择所属行业。

        1.2.4 设置访问权限。如您选择“公开”,那么全部访客均可访问您的API门户,但订阅和调试则需要注册华为云账号;如您选择“私人”,则仅有同一租户下的IAM账号可以访问。

        1.2.5 填写联络人信息。包括联络人名称及联络人电子邮箱。

        1.2.6 点击“确定”完成API门户创建。

        1.2.png

    1.3 设置门户

        1.3.1 点击进入您已创建的API门户

        1.3.1.png

        1.3.2 点击右侧导航栏中“门户设置”,对门户进行编辑

        1.3.2.png

        1.3.3 进入门户设置后,您可以上传门户图标、更改门户Banner、设置是否显示联络人信息,并修改您在2节中完成的设置内容。

        1.3.3.png

        1.3.4 您也可以将您的门户链接复制后,发送给他人。如您不需要此门户,也可以删除门户(建议您谨慎执行该操作)。

        1.3.4.png

        1.3.5 完成修改后,系统自动保存。

2      创建及编辑云产品

    2.1 点击“新增云产品”

        2.1.png

    2.2 填写您的云产品名称及云产品描述,然后点击“确定”。

        2.2.png

    2.3 编辑云产品。点击需要编辑的云产品,您可以更改云产品图标、云产品名称、云产品描述,也可以删除云产品。

        2.3.png

3      导入Swagger文件

    3.1 如您已有.yaml.yml格式文件,可直接上传。点击右侧导航栏中“OpenAPI”,选择您要上传Swagger文件的云产品,点击“导入Swagger文件”,点击上传或拖入Swagger文件。

        3.1.png

    3.2 如您没有.yaml.yml格式文件,您可以通过华为云CodeArts APISwagger编辑器设计API,并生成.yaml.yml格式文件。当前华为云CodeArts API处于邀测阶段,如您需要体验试用,可点击报名>>,工作人员与您取得联系后,将为您开通试用白名单。

        3.2.png


    3.3 完成上传后点击发布,即生成了您的一个云产品API文档

        3.3-1.png

        3.3-2.png

    3.4 点击门户预览即可查看您已创建的云产品及API,您的开发者可在门户内实现在线调试、调试结果查看、代码示例生成等更多操作。

        3.3-3.PNG

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。