12343052 发表于 2017-6-27 11:27:25

构建标准OpenStack API接口文档

  1.构建API接口文档标准参考:
  http://docs.openstack.org/contributor-guide/api-guides.html
  2.构建API接口文档步骤参考下面的Patch:
  https://review.openstack.org/#/c/361791/
  https://review.openstack.org/#/c/305870/
  https://review.openstack.org/#/c/305973/
  3.创建API接口文档的CI已经如何发布到OpenStack网站。
  (1)创建CI:https://review.openstack.org/#/c/305464/
  (2)发布成Html:https://review.openstack.org/#/c/305485/
  4.其他问题。
  (1) 从Project-Config项目中确认目前是否只有Nova在做这个事情?
  magnum,senlin等其他项目也在做API文档标准规范。
  (2) openstack/openstack-manuals在做什么?
  只有一个链接指向:http://developer.openstack.org/api-ref.html
  (3) openstack/api-site在做什么?
  所有项目的api-ref都已经迁移到自己的项目,所以以后的项目api-ref只需要在Karbor项目内部维护即可。
  (4) swagger是一种根据yaml来定义API的方式,Karbor设计之初采用的就是swagger,但不是OpenStack的标准规范。
  http://editor.swagger.io/#/?import=http:%2F%2Ffpaste.org%2F324841%2F81061214%2Fraw%2F
页: [1]
查看完整版本: 构建标准OpenStack API接口文档