构建标准OpenStack API接口文档
2016-09-02 09:30
176 查看
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
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
相关文章推荐
- python 6-4 如何构建xml文档使用标准库中的xml.etree.ElementTree 构建ElementTree,使用write方法写入文档
- swagger-ui教程 构建api接口文档工具
- swagger-ui教程-构建api接口文档工具
- app后端开发一:swagger-ui教程-构建api接口文档工具
- swagger-ui教程-构建api接口文档工具
- swagger-ui教程-构建api接口文档工具
- Spring Boot中使用Swagger2构建强大的RESTful API文档
- 如何使浏览器打开时,默认的文档模式就是标准模式
- Spring REST Docs 构建java项目文档
- Spring Boot中使用Swagger2构建强大的RESTful API文档
- 基于spring-boot使用Swagger构建restful api文档
- Openstack api 学习文档 & restclient使用文档
- 一份标准的HTML文档必须有的HTML标签
- 部署hadoop标准文档及标准目录
- 软件标准文档
- 软件标准项目文档
- 中国电信3G--sp端短信彩信wap技术标准文档-开发包
- C++标准库及其保留字(关键字)——附:C++标准文档
- 软件标准项目文档
- Spring Boot中使用Swagger2构建强大的RESTful API文档