forked from raml-org/raml-org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
document-your-api.html
34 lines (27 loc) · 2.55 KB
/
document-your-api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
---
layout: page
title: Document Your API
permalink: /developers/document-your-api
---
<h2>REST API Documentation Made Easy</h2>
<p>RAML makes documenting your REST API easy, and even better keeps your API documentation in sync! With hundreds of open source tools like the API Console, API Notebook, and RAML 2 HTML documentation can be generated quickly and on the fly, and with parsers for nearly every language you can even create your own custom docs and interactive scripts like <a href="https://developer.epages.com/apps/api-reference/resource-carts.html" target="_blank">e.Pages</a> and <a href="https://developer.spotify.com/web-api/console/get-album/" target="_blank">Spotify</a>.</p>
<h3 >API Console</h3>
<img src="/images/doc_apiconsole_0.png" style="float: left; margin-right: 20px;" /><p>The API Console provides live interactive documentation that lets users try out your API in real time, making real calls. You can easily install the API Console on any site with just a few lines of JavaScript or host it yourself (requires Node.js)</p>
<br />
<a href="/projects#q:api%20console" class="button info">More Info</a> <a href="https://github.com/mulesoft/api-console" class="button" target="_blank">Download</a>
<br style="clear: left;" />
<br />
<h3>RAML to HTML</h3>
<img src="/images/doc_raml2html_0.png" style="float: left; margin-right: 20px;" /> <p>RAML to HTML is a documentation tool that outputs a single HTML page console based on a RAML definition. It's written in NodeJS and it can be executed as a command line.</p>
<br />
<a href="/projects#q:raml%20to%20html" class="button info">More Info</a> <a href="https://github.com/kevinrenskers/raml2html" class="button" target="_blank">Download</a>
<br style="clear: left;" />
<br />
<h3>RAML2HTML for PHP</h3>
<img src="/images/doc_raml2htmlphp_0.png" style="float: left; margin-right: 20px;" /><p>RAML 2 HTML for PHP is a simple application that makes use of multiple templates to allow you to build and customize your API Docs using RAML. Version 1 includes more advanced document capabilities including code samples, inclusion of Disqus comments, and more.</p>
<br />
<a href="/projects#q:raml%202%20html%20for%20php" class="button info">More Info</a> <a href="https://github.com/mikestowe/php-raml2html" class="button" target="_blank">Download</a>
<br style="clear: left;" />
<br />
<h3>Other Tools</h3>
<p>These are just some of the more popular tools for building out documentation for your API. You can find many more tools available in our <a href="/projects">Projects Library</a>.</p>