本文原作者为开源企业级容器Registry Harbor项目的工程师王锟,主要介绍如何使用Harbor内置Swagger来测试和调用Harbor的API。笔者做了少量修改。
首先,我们来看看Swagger如何描述和定义RESTful API。Swagger提供在线所见即所得的编辑器( http://editor.swagger.io/ ),用户可以在编辑器左侧输入符合Swagger规范的YAML或JSON配置,右侧会根据输入的内容实时显示出实际的效果,如果输入有错误,还会有提示出来教你如何改正,真的很方便!如何编写符合规范的Swagger定义文件请参考( http://swagger.io/specification/ )。
Swagger简介
Swagger是最流行的RESTful API开源工具,包含一整套代码库、编辑器、代码生成器等,可用于API的描述、定义、生成以及可视化等方面。我们可以在 http://www.swagger.io 查看它的详细介绍,下载它的源码并集成到项目中来。Harbor是VMware新近开源的企业级容器Registry项目( http://github.com/vmware/harbo r),用户可在私有环境中部署Harbor,实现容器镜像的权限管理、图形化管理、LDAP/AD认证集成以及日志审计等功能。Harbor还提供RESTful API,其他容器管理平台可以很方便地集成Harbor的功能。本文介绍如何使用Harbor内嵌的Swagger工具,调用和测试RESTful API。首先,我们来看看Swagger如何描述和定义RESTful API。Swagger提供在线所见即所得的编辑器( http://editor.swagger.io/ ),用户可以在编辑器左侧输入符合Swagger规范的YAML或JSON配置,右侧会根据输入的内容实时显示出实际的效果,如果输入有错误,还会有提示出来教你如何改正,真的很方便!如何编写符合规范的Swagger定义文件请参考( http://swagger.io/specification/ )。