構建標准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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM