Docker镜像仓库Harbor之Swagger REST API整合配置

目录

  • Swagger介绍
  • 预览Harbor REST API
  • Harbor与Swagger 整合配置
  • FAQ

1、Swagger 介绍

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTFul 风格的 Web 服务。通过 Swagger,我们可以方便的、快速的实现 RESTFul API,同时它也提供UI界面,可以直观的管理和测试各个API接口,它还可以集成到各种开发语言中,大大提高了我们日常工作效率。

2、预览 Harbor REST API 整合配置

我们可以通过 Harbor 提供的 REST API yaml 描述文件,通过在线 Swagger 编辑器,来直观的预览一下 Harbor REST API信息。 1) 下载或直接复制 Harbor 的 swagger.yaml 信息到官网在线 Swagger 编辑器 左侧区域,右侧即可直观看到信息。 2)直接在官网在线 Swagger 编辑器,通过Import URL或Import File,右侧即可直观看到信息。

Harbor swagger.yaml 地址
URL1:https://raw.githubusercontent.com/vmware/harbor/master/docs/swagger.yaml
URL2:https://github.com/vmware/harbor/blob/master/docs/swagger.yaml

3、Harbor与Swagger整合配置

1)下载 prepare-swagger.shswagger.yaml 到 Harbor 安装目录下,我本地虚拟机安装目录为:/home/wanyang3/harbor

$ cd /home/wanyang3/harbor

地址1:
$ wget https://raw.githubusercontent.com/vmware/harbor/master/docs/prepare-swagger.sh 
$ wget https://raw.githubusercontent.com/vmware/harbor/master/docs/swagger.yaml

地址2:
$ wget https://github.com/vmware/harbor/blob/master/docs/prepare-swagger.sh
$ wget https://github.com/vmware/harbor/blob/master/docs/swagger.yaml

2)编辑 prepare-swagger.sh,修改 SCHEME 和 SERVER_IP 配置

1、修改SCHEME为Harbor配置文件harbor.cfg中设置的ui_url_protocol=http
SCHEME=http

2、修改SERVER_ID为Harbor服务的IP或域名地址,这里我们使用ip
SERVER_ID=10.236.60.101

3)给 prepare-swagger.sh 可执行权限

chmod +x prepare-swagger.sh

4)执行 prepare-swagger.sh 文件,它会下载依赖的 Swagger 包,并将解压缩目录复制到../src/ui/static/vendors目录,并修改index.html相关配置。同时复制swagger.yaml文件复制到../src/ui/static/resources/目录,并修改yaml相关配置。

 ./prepare-swagger.sh

5)编辑 docker-compose.yml 文件,在 ui.volumes 下增加挂载 swagger 的配置

$ vim docker-compose.yml

...
ui:
  ... 
  volumes:
    - ./common/config/ui/app.conf:/etc/ui/app.conf:z
    - ./common/config/ui/private_key.pem:/etc/ui/private_key.pem:z
    - /data/secretkey:/etc/ui/key:z
    - /data/ca_download/:/etc/ui/ca/:z
    ## 下边就是增加的配置 ##
    - ../src/ui/static/vendors/swagger-ui-2.1.4/dist/:/harbor/static/vendors/swagger/:z
    - ../src/ui/static/resources/yaml/swagger.yaml:/harbor/static/resources/yaml/swagger.yaml:z
    ...

6)重启 Harbor 容器

$ docker-compose down -v
$ docker-compose up -d 

7)访问 Harbor Swagger Web 查看 REST API,访问地址为:http://10.236.60.101/static/vendors/swagger/index.html

注意:在使用 Harbor API 时,是需要 session ID 的,当我们未登录 Harbor 时,直接使用API将得不到任何结果,这里如果我们想使用 Swagger UI 点击访问API返回结果,那么需要在浏览器中先登录 Harbor Web UI,登录后新开一个tab,在这个tab访问 Harbor Swagger Web,将会得到正常的响应结果,因为这时session已经共享,会话认证通过。我们以 http://10.236.60.101/api/users/current 获取当前用户信息接口为例:

4、FQA

上边第三步的第5步,编辑 docker-compose.yml 文件,在 ui.volumes 下增加挂载 swagger 的配置时,

## 下边就是增加的配置 ##
- ../src/ui/static/vendors/swagger-ui-2.1.4/dist/:/harbor/static/vendors/swagger/:z
- ../src/ui/static/resources/yaml/swagger.yaml:/harbor/static/resources/yaml/swagger.yaml:z

注意:…swagger-ui-2.1.4/dist 后边的/以及 …vendors/swagger 后边的/得带上,否则dist目录下的文件不能正常挂载到容器swagger目录下,访问时报错404。

这里我们着重介绍了Harbor之Swagger REST API整合配置相关操作,忽略Harbor安装配置,详细可以参考上一篇文章 Docker镜像仓库Harbor之搭建及配置

参考资料

  1. harbor swagger configure
  2. swagger docs

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏潇涧技术专栏

Publish Gradle Android Library to jCenter Repository

本文主要介绍如何通过Gradle将Android库项目上传到jCenter仓库中。

713
来自专栏杨熹的专栏

详解Mac配置虚拟环境Virtualenv,安装Python科学计算包

最近正在自学Python做科学计算,当然在很多书籍和公开课里最先做的就是安装Numpy, Scipy, Matplotlib等包,不过每次安装单独的包时,...

2848
来自专栏F_Alex

SpringCloud-微服务的注册与发现Eureka(二)

3.5K4
来自专栏猿天地

Spring Boot中整合Sharding-JDBC读写分离示例

在我《Spring Cloud微服务-全栈技术与案例解析》书中,第18章节分库分表解决方案里有对Sharding-JDBC的使用进行详细的讲解。

2603
来自专栏北京马哥教育

浅谈linux用户与用户组的概念

1.用户 用户是能够获取系统资源的权限的集合. .linux用户组的分类: a.管理员 root :具有使用系统所有权限的用户,其UID 为0. ...

3296
来自专栏冷冷

SpringMVC 文件下载时 浏览器不能正确显示另存的文件名

问题:通过打印输出流的方式把文件下载到本地,但是在firebox 中 下载的文件不显示文件的文件名,造成文件不能直接打开,其他浏览器可以直接打开. 原因: 主要...

1995
来自专栏鬼谷君

Jenkins 集成Sonar代码质量扫描

在jenkins插件安装界面安装: 插件名 SonarQube Scanner for Jenkins

754
来自专栏漫漫全栈路

Linux下用户及用户权限管理

虽然很早就开始接触和使用Linux系列的系统,但是一直都是停留在使用层面,只能作为一个User,而并不是一个Developer,而要真正掌握Linux系列的系...

3393
来自专栏Hadoop实操

如何清理Sqoop脚本产生的临时编译目录

在使用Sqoop命令进行数据抽取时,执行的抽数脚本会在/tmp/sqoop-${user}/compile目录下产生临时的编译文件,脚本执行成功后这些生成的临时...

2002
来自专栏用户画像

新建gradle项目 并添加springboot框架支持

参考文档:http://projects.spring.io/spring-boot/#quick-start

751

扫码关注云+社区