API文档主题或模板 [英] API Documentation Theme or Template

问题描述

我要寻找是一个字preSS的主题，或者只是原始的CSS，图片，一个伟大的API文档模板使用的HTML。我建立一个RESTful API，并需要创建的文档，并想卵圆形编写我们自己的API文档模板。我并不需要自动生成的文件，只是一个非常好看的API文档主题/模板。

I am looking for either a Wordpress theme, or just the raw CSS, Images, HTML of a great looking API Doc template to use. I am building a RESTFul API, and need to create documentation, and would like to ovoid writing our own API doc template. I don't need auto-generating documentation, just a great looking API Doc theme/template.

我真的很喜欢Mozilla的 API文档

I really like the Mozilla API Doc

此外，邮戳有一些伟大的 API文档以及

Also, Postmark has some great API Doc as well

推荐答案

扬鞭是一个很酷的API文档/沙箱框架。你可以在这里找到更多信息： http://swagger.io/

Swagger is a cool API Documentation/Sandbox framework. You can find out more info here: http://swagger.io/

- 更新 -

有也被称为 API蓝图一个伟大的开源项目，它使用降价的一种特殊的香味。关于这个项目很酷的事情是，其他项目可以解析这些文件并创建引人注目的文档解决方案。 蜂房保持该项目，并拥有自己的全功能的API文档解决方案。使用API​​蓝图另一个（简单的）解决方案是 Aglio 。

There is also a great open-source project called API Blueprint which uses a special flavor of Markdown. The cool thing about this project is that other projects can parse these files and create compelling documentation solutions. Apiary maintains the project and has their own full-featured API documentation solution. Another (simpler) solution that uses API Blueprint is Aglio.

我想因为我拉扯大API蓝图，我还不如提 RAML 的了。这是一个类似的API蓝图，因为这是其他项目可以解析创建文档的语言。我没有用错构瘤，但我5分钟的评估是，这是不容易跳进作为API蓝图。

I guess since I'm bringing up API Blueprint, I might as well mention RAML too. It is similar to API Blueprint because it is a language that other projects can parse to create documentation. I have not used RAML, but my 5-minute assessment is that it isn't as easy to jump into as API Blueprint.

这篇关于API文档主题或模板的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！