使用Swagger查看与测试Harbor的REST API
来源:互联网 发布:调度数据网络柜 编辑:程序博客网 时间:2024/06/06 00:51
通过Swagger查看和测试Harbor的REST API
Swagger文件提供了查看和测试Harbor的REST API的方式。首先,请获取Harbor的源码:
git clone git@github.com:vmware/harbor.git
查看Harbor的Rest API
- 首先在Harbor项目的doc目录下打开 swagger.yaml 文件;
- 复制里面的所有内容到Swagger的在线编辑器 http://editor.swagger.io. 然后就能在页面的右侧看到Harbor的REST API的描述信息。
测试Harbor REST API
你可能需要不时的手动测试Harbor REST API. 你可以部署Swagger文件到Harbor服务节点上。
注意: 当使用Swagger向Harbor发送REST请求时,你可能不经意间修改了Harbor的数据。因此,不建议在Harbor的生产环境使用Swagger。
进入Harbor项目的 docs 目录.
cd docs
在 docs 目录下编辑脚本文件 prepare-swagger.sh .
vi prepare-swagger.sh
更改Harbor服务器的schema协议。
SCHEME=<HARBOR_SERVER_SCHEME>
更改 SERVER_IP 为你的Harbor服务的IP.
SERVER_IP=<HARBOR_SERVER_DOMAIN>
运行该脚本. 它会下载Swagger包并解压到Harbor项目的 static 目录下。
./prepare-swagger.sh
进入 make 目录
cd ../make/dev
编辑 docker-compose.yml 文件.
vi docker-compose.yml
在 docker-compose.yml 文件ui.volumes 段中的添加两行。
...ui: ... volumes: - ./config/ui/app.conf:/etc/ui/app.conf - ./config/ui/private_key.pem:/etc/ui/private_key.pem ## add two lines as below ## - ../../src/ui/static/vendors/swagger-ui-2.1.4/dist:/go/bin/static/vendors/swagger - ../../src/ui/static/resources/yaml/swagger.yaml:/go/bin/static/resources/yaml/swagger.yaml ...
Rebuild Harbor 项目
docker-compose build
清除上一个运行版本. 注意: 该命令不会清理存在的数据。
docker-compose rm
开始编译新Harbor
docker-compose up
由于Harbor API通常需要携带session ID, 请在浏览器中先登录Harbor
- 在浏览器中开启另一个页面用于共享session id.
输入Swagger页面的URL.
http://<HARBOR_SERVER>/static/vendors/swagger/index.html
现在,你应该就可以看到 swagger.yaml 文件加载出来的swagger的API的UI页面, 时刻注意使用swagger提交的REST请求可能改变Harbor的数据.
0 0
- 使用Swagger查看与测试Harbor的REST API
- 用Swagger调用Harbor Registry的REST API
- Swagger-UI 基于REST的API测试/文档类插件
- Swagger-UI 基于REST的API测试/文档类插件
- Swagger-UI 基于REST的API测试/文档类插件
- Docker镜像仓库Harbor之Swagger REST API整合配置
- 使用Swagger,Swagger-UI生成REST API接口文档
- Swagger-UI 基于REST的API管理
- Swagger:Rest API的描述语言
- 使用Spring Boot&Swagger快速构建REST API并生成优美的API文档
- django-rest-swagger的优化使用
- 使用 Rest-Assured 测试 REST API
- Django下测试与调试REST API的方法
- 使用swagger生成API的json文件
- 使用swagger创建功能强大的API
- SpringBoot + mybatis + Swagger快速构建REST API并生成优美的API文档
- 使用Jmeter进行rest API测试
- Director REST API 的使用
- 最全、最常用的正则表达式
- win10安装 Genymotion ARM Translation教程(避免掉入大坑)
- Python+Selenium从零开始到框架设计的结束总结篇
- JDK自带工具keytool生成ssl证书
- Android WebRTC 音视频开发总结(一)
- 使用Swagger查看与测试Harbor的REST API
- 二十种特征变换方法及Spark MLlib调用实例(Scala/Java/python)(二)
- java jdk1.7与jdk1.8 区别
- confluence配置开发,开发API
- interfaces
- JAVA中的堆内存和栈内存
- Objective-C如何自己实现一个基于数组下标的属性访问模式
- 数据类型
- Unity.VR.04MainMenu场景的交互