forked from raml-org/raml-org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdeveloper.html
executable file
·147 lines (126 loc) · 7.24 KB
/
developer.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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
---
layout: default
title: Developer
permalink: /developer
---
<div class="ramldevel">
<div class="container">
<div class="row">
<div class="col-md-4">
<div class="thumbnail">
<img src="/images/developers---try-some-examples.png" alt="RAML Examples" class="img-responsive" />
<div class="caption">
<a href="https://github.com/raml-apis" target="_blank">RAML Examples</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="thumbnail">
<img src="/images/developers-hundreds-of-open-source-projects.png" alt="Hundreds of Open source Projects" class="img-responsive" />
<div class="caption">
<a href="/projects" style="padding-left: 46px;">Hundreds of Open Source Projects</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="thumbnail">
<img src="/images/developers-tutorials.png" alt="Get Started with Our Tutorials" class="img-responsive" />
<div class="caption">
<a href="/developers/raml-100-tutorial" style="padding-left: 56px;">Get Started with Our Tutorials</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="design-api">
<div class="container">
<div class="row">
<div class="col-md-6">
<h2>Design Your API</h2>
<p>
What if, in less than 5 minutes you could build out your whole API and see exactly what it looks like, and even test it out? RAML lets you use a human readable format, instead of writing code, which means that after you design it - anyone in QA, technical writing, or even your CEO can make documentation changes without breaking a thing. The best part is, RAML was made for developers and incorporates important design best practices like modeling, patterns, templating, and code reuse.
</p>
<a href="/developers/design-your-api">Learn more about how RAML can help with Design</a>
</div>
<div class="col-md-6">
<img src="images/design_editor.png" alt="Design your api" class="img-responsive" />
</div>
</div>
</div>
</div>
<div class="build-api">
<div class="container">
<div class="row">
<div class="col-md-6">
<img src="images/design_build.png" alt="Build API" class="img-responsive" />
</div>
<div class="col-md-6">
<h2>Build Your API</h2>
<p>Once you’ve designed your API, you can import the RAML file into numerous tools to generate the API in your language of choice. For larger integration projects, you can even use some of the most popular integration and API frameworks to build out your API. Of course, you don’t have to use a server code generator at all - you can still build your API from scratch. </p>
<p>And since RAML lets you generate a mock of the entire API in literally milliseconds you can now develop API dependent apps and devices in parallel and launch faster in market.</p>
<a href="/developers/build-your-api" >Learn more about how RAML can help you Build your API</a>
</div>
</div>
</div>
</div>
<div class="test-api">
<div class="container">
<div class="row">
<div class="col-md-6">
<h2>Test your API</h2>
<p>
Who doesn’t love writing hours worth of unit tests… that end up being copy and pasted code over and over again? What if you could generate a majority of your tests just by running a quick script?
</p>
<p>
Another great thing about RAML is that it is backed by a huge community and has hundreds of scripts and tools available to generate your unit tests for you. You’ll also find projects and services that perform additional, extensive tests on your API, ensuring your API is ready to go before it ever hits production.
</p>
<a href="/developers/test-your-api">Learn more about how RAML can help you Test your API</a>
</div>
<div class="col-md-6">
<img src="images/design_tests.png" alt = "Test your API" class="img-responsive" />
</div>
</div>
</div>
</div>
<div class="document-api">
<div class="container">
<div class="row">
<div class="col-md-6">
<img src="images/design_document.png" alt="Document API" class="img-responsive" />
</div>
<div class="col-md-6">
<h2>Document Your API</h2>
<p>With RAML - you can say goodbye to having to write extensive documentation, documentation testing, and struggling to keep your docs in sync. RAML is an API description language - meaning your API is already being described, and it was designed with documentation in mind. </p>
<p>You can easily add markdown to your resource and method descriptions, or take advantage of the documentation property of RAML to quickly and effortlessly generate all of your documentation using one of the many freely available, and customizable, tools with just the click of a button. RAML lets you focus on writing code, not documentation. </p>
<a href="/developers/document-your-api">Learn more about how RAML can help you document your API</a>
</div>
</div>
</div>
</div>
<div class="share-api">
<div class="container">
<div class="row">
<div class = "col-md-6">
<h2>Share & Support your API</h2>
<p>What good is an API if nobody is using it? With RAML you can quickly - at the click of a button or with a little basic JavaScript - generate interactive tools such as API Consoles, API Notebooks that walk users through your API step by step, or even create SDKs or code libraries for today’s most popular languages. </p>
<p>RAML is also supported by many tools and services, letting users quickly import your API into their solution in order to use it with little to no code required on their part. RAML can even change the way you handle support! </p>
<a href = "/developers/share-support-your-api">Learn more about how RAML can help you Share your API</a>
</div>
<div class="col-md-6">
<img src="images/design_share.png" alt = "share and support your API" class="img-responsive" />
</div>
</div>
</div>
</div>
<div class="do-more-with-less">
<div class="do-more-content">
<h2>Do more with less</h2>
<p>Instead of having to struggle and do things in-house, RAML aims to let you do more with less - meaning a
faster time to market for your company - and more time to focus on coding for you.</p>
<br/>
<div class="ramllink-wrapper">
<a href ="https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/" target="_blank" class="raml-links" onclick="ga('send', 'event', 'CTA', 'Click', '1.0-spec');">Read the Specification</a>
</div>
</div>
</div>