构建标准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

时间: 2024-10-17 20:34:32

构建标准OpenStack API接口文档的相关文章

app后端开发二:API接口文档工具

悲伤的历史 在进行app后端开发过程中,后端会提供出来很多的api接口供前端开发使用,为了让前端开发人员顺利使用,我们会写好一份文档,告诉他们这个接口你该用 GET 还是 POST 来访问,同时访问的时候该给我传递一些什么参数,以及正确的时候我会返回什么给你,已经返回的数据样式以及字段解释等等这些事情,我们都需要在文档中写好写清楚. 在 app后端开发一:基于swagger-ui构建api接口文档工具 这篇博客中,我写了 swagger-ui 的好处以及优势.但是在使用过程中,发现不够给力.我想

SpringBoot + Swagger2 自动生成API接口文档

spring-boot作为当前最为流行的Java web开发脚手架,相信越来越多的开发者会使用其来构建企业级的RESTFul API接口.这些接口不但会服务于传统的web端(b/s),也会服务于移动端.在实际开发过程中,这些接口还要提供给开发测试进行相关的白盒测试,那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题. 假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝,那么尝试一下Swagger2 方式,一定会让你有不一样的开发体验: 功能丰富 :支持多种注解,自动生成接

Swagger UI教程 API 文档神器 搭配Node使用 web api 接口文档 mvc接口文档

两种方案 一.Swagger 配置 web Api 接口文档美化 二.通过NodeJS 发布Swagger UI 配置api 文档 先说一下简单的 Swagger 配置 web Api  Swagger-UI本身只提供在线测试功能,要集成它还需要告诉它本项目提供的各种服务和参数信息.这里就需要一些工作量了,不过好在许多第三方库已经给我们完成了这一工作.我这里用的是Swashbuckle,使用它也比较简单,直接使用Nuget添加其程序包即可: 1.初始化包  PM> Install-Package

Api接口文档管理工具,你知道哪些呢?

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

关于api接口文档RAP和swagger

前言: 在之前的项目中用了将近一年的RAP,RAP是由阿里开源出来的,非常好用.github地址:https://github.com/thx/RAP. 当初在用此工具时,项目成员需要在接口文档在所改动后,发邮件到项目组成员,由于rap当时没有此功能,所以还下载源码,增加了发邮件功能. 将此功能代码commit到了社区,好像社区没有接纳合入. 后来使用了一年后,发现了swagger似乎使用很方便,直接跟代码进行结合,需要重新使用其他工具进行配合了. 所以以下时对swagger的spring集成说

app后端开发一:基于swagger-ui构建api接口文档工具

声明 之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万一以后找工作,别人一看我博客这么多内容,是不是很屌? 这次文章先从构建resetful风格的api文档工具开始.没有一个好的文档工具,在app前端人员开发过程中会导致开发效率极低,而且时不时的,他们就来找你跟他们断点一下. 我的文档经历 这里先不讨论我的数据传输是否合理,仅仅以这些数据作为一个演示.后面会有专门的章节进行app数据传

Spring Cloud Zuul中使用Swagger汇总API接口文档

有很多读者问过这样的一个问题:虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档中? 如果您还不了解Spring Cloud Zuul和Swagger,建议优先阅读下面两篇,有一个初步的了解: Spring Cloud构建微服务架构:服务网关(基础) Spring Boot中使用Swagger2构建强大的RESTful API文档 准备工作 上面说了问题的场景是在微服务化之后,所

Api接口文档软件Showdoc

showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点 1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了) 2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作. 3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览 4:支持响应式,手机电脑同样精彩 5:支持项目转让 6:支持模版插入 7:支持历史版本,你可以把操作恢复到以前的版本. 8:showdoc完全开源 9:可以部署到自己的服务器 10:如果在线使

.NET Core使用swagger进行API接口文档管理

一.问题背景 随着技术的发展,现在的开发模式已经更多的转向了前后端分离的模式,在前后端开发的过程中,联系的方式也变成了API接口,但是目前项目中对于API的管理很多时候还是通过手工编写文档,每次的需求变更只要涉及到接口的变更,文档都需要进行额外的维护,如果有哪个小伙伴忘记维护,很多时候就会造成一连续的问题,那如何可以更方便的解决API的沟通问题?Swagger给我们提供了一个方式,由于目前主要我是投入在.NET Core项目的开发中,所以以.NET Core作为示例 二.什么是Swagger S