-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
310 lines (298 loc) · 15 KB
/
index.html
File metadata and controls
310 lines (298 loc) · 15 KB
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<!DOCTYPE html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="description" content="manual">
<meta name="generator" content="Paradox, paradox-material-theme=0.6.0, mkdocs-material=3.0.3">
<meta name="lang:clipboard.copy" content="Copy to clipboard">
<meta name="lang:clipboard.copied" content="Copied to clipboard">
<meta name="lang:search.language" content="">
<meta name="lang:search.pipeline.stopwords" content="true">
<meta name="lang:search.pipeline.trimmer" content="true">
<meta name="lang:search.result.none" content="No matching documents">
<meta name="lang:search.result.one" content="1 matching document">
<meta name="lang:search.result.other" content="# matching documents">
<meta name="lang:search.tokenizer" content="[\s\-]+">
<meta name="description" content="manual">
<link rel="shortcut icon" href="assets/images/favicon.png">
<title>endpoints4s</title>
<link rel="stylesheet" href="assets/stylesheets/application.451f80e5.css">
<link rel="stylesheet" href="lib/material__tabs/dist/mdc.tabs.min.css">
<link rel="stylesheet" href="lib/prettify/prettify.css">
<script src="assets/javascripts/modernizr.1aa3b519.js"></script>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
<style>
body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}
code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}
</style>
<link rel="stylesheet" href="assets/fonts/font-awesome.css">
<link rel="stylesheet" href="assets/fonts/material-icons.css">
<link rel="stylesheet" href="assets/stylesheets/paradox-material-theme.css">
<link rel="stylesheet" href="snippets.css">
</head>
<body
>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="index.html" title="endpoints4s" class="md-header-nav__button md-logo">
<i class="md-icon">local_library</i>
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
endpoints4s
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
<label class="md-icon md-search__icon" for="__search"></label>
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"></button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="result">
<div class="md-search-result__meta">
Type to start searching
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/endpoints4s/endpoints4s"
title="Go to repository"
class="md-source"
data-md-source="github">
<div class="md-source__icon">
<i class="fa fa-github"></i>
</div>
<div class="md-source__repository">
endpoints4s/endpoints4s
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0" style="visibility: hidden">
<label class="md-nav__title md-nav__title--site" for="drawer">
<a href="index.html" title="endpoints4s" class="md-nav__button md-logo">
<span class="md-nav__button md-logo">
<i class="md-icon">local_library</i>
</a>
<a href="index.html" title="endpoints4s">
endpoints4s
</a>
</label>
<div class="md-nav__source">
<a href="https://github.com/endpoints4s/endpoints4s"
title="Go to repository"
class="md-source"
data-md-source="github">
<div class="md-source__icon">
<i class="fa fa-github"></i>
</div>
<div class="md-source__repository">
endpoints4s/endpoints4s
</div>
</a>
</div>
<ul>
<li><a href="use-cases.html" class="page">Use Cases</a></li>
<li><a href="quick-start.html" class="page">Quick start</a></li>
<li><a href="design.html" class="page">Design in a nutshell</a></li>
<li><a href="algebras-and-interpreters.html" class="page">Algebras and interpreters</a>
<ul>
<li><a href="algebras/endpoints.html" class="page"><code>Endpoints</code></a></li>
<li><a href="algebras/json-entities.html" class="page">JSON Entities</a></li>
<li><a href="algebras/json-schemas.html" class="page">JSON Schemas</a></li>
<li><a href="algebras/chunked-entities.html" class="page">Chunked Entities</a></li>
<li><a href="algebras/middlewares.html" class="page">Middlewares</a></li>
<li><a href="algebras/assets.html" class="page">Assets</a></li>
<li><a href="algebras/mux-endpoints.html" class="page">Multiplexed Endpoints</a></li>
<li><a href="interpreters/pekko-http.html" class="page">Pekko HTTP</a></li>
<li><a href="interpreters/http4s.html" class="page">http4s</a></li>
<li><a href="interpreters/scalajs-web-fetch.html" class="page">Scala.js web client (Fetch)</a></li>
<li><a href="interpreters/sttp.html" class="page">sttp</a></li>
<li><a href="interpreters/openapi.html" class="page">OpenAPI</a></li>
<li><a href="interpreters/circe.html" class="page">Circe</a></li>
<li><a href="interpreters/play-json.html" class="page">Play JSON</a></li>
</ul></li>
<li><a href="guides.html" class="page">Guides</a>
<ul>
<li><a href="guides/tupler.html" class="page"><code>Tupler</code></a></li>
<li><a href="guides/custom-authentication.html" class="page">Application-specific authentication</a></li>
</ul></li>
<li><a href="community.html" class="page">Community</a></li>
<li><a href="comparison.html" class="page">Comparison with similar tools</a></li>
<li><a href="talks.html" class="page">Talks and Articles</a></li>
<li><a href="release-and-compatibility-notes.html" class="page">Release and Compatibility Notes</a></li>
</ul>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul>
<li><a href="index.html#endpoints4s" class="header">endpoints4s</a>
<ul>
<li><a href="index.html#getting-started" class="header">Getting started</a></li>
<li><a href="index.html#contributing" class="header">Contributing</a></li>
<li><a href="index.html#sponsors" class="header">Sponsors</a></li>
</ul></li>
</ul>
</nav>
</nav>
<ul style="display: none">
<li class="md-nav__item md-version" id="project.version">
<label class="md-nav__link" for="__version">
<i class="md-icon" title="Version">label_outline</i> 1.12.1
</label>
</li>
</ul>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul>
<li><a href="index.html#endpoints4s" class="header">endpoints4s</a>
<ul>
<li><a href="index.html#getting-started" class="header">Getting started</a></li>
<li><a href="index.html#contributing" class="header">Contributing</a></li>
<li><a href="index.html#sponsors" class="header">Sponsors</a></li>
</ul></li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<div class="md-content__searchable">
<h1><a href="#endpoints4s" name="endpoints4s" class="anchor"><span class="anchor-link"></span></a>endpoints4s</h1>
<p>endpoints4s is a Scala library for remote communication. It ensures that HTTP servers, HTTP clients, and documentation always agree on the same protocol.</p>
<ul>
<li><strong>maintenance is simplified</strong>: the API documentation is automatically updated when an endpoint is modified ;</li>
<li>errors are raised at <strong>compile-time</strong> if endpoints are invoked with incompatible parameters.</li>
</ul>
<p>Servers, clients and documentation are <em>all</em> derived from a <em>single</em> source of truth describing the underlying protocol details (e.g., which verb, path, query parameters, headers, authentication strategy, etc. to use). For instance, here is an endpoint for incrementing a counter. It uses the HTTP verb <code>POST</code>, the URL path <code>/increment</code>, a JSON request entity containing an <code>Increment</code> value, and it returns an empty response.</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/endpoints4s/endpoints4s/tree/master/documentation/examples/quickstart/endpoints/src/main/scala/quickstart/CounterEndpoints.scala#L34-L38" target="_blank" title="Go to snippet source">source</a><code class="language-scala">val increment: Endpoint[Increment, Unit] =
endpoint(
post(path / "increment", jsonRequest[Increment]),
ok(emptyResponse)
)</code></pre>
<p>From the client perspective, calling an HTTP endpoint is as simple as calling a function:</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/endpoints4s/endpoints4s/tree/master/documentation/examples/quickstart/client/src/main/scala/quickstart/CounterClientFuture.scala#L16" target="_blank" title="Go to snippet source">source</a><code class="language-scala">val eventuallyDone: Future[Unit] = increment(Increment(step = 42)).future</code></pre>
<p>Conversely, from the server perspective implementing an HTTP endpoint is as simple as implementing a function:</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/endpoints4s/endpoints4s/tree/master/documentation/examples/quickstart/server/src/main/scala/quickstart/CounterServer.scala#L28" target="_blank" title="Go to snippet source">source</a><code class="language-scala">increment.implementedBy(inc => counter.single += inc.step)</code></pre>
<p>endpoints4s takes care of constructing the HTTP requests and responses and decoding the server responses or client requests into high-level data types according to the endpoint descriptions.</p>
<p>In contrast with <a href="comparison.html">most other approaches</a>, endpoints4s is a pure, “<em>vanilla</em>”, Scala library. <strong>No code generation</strong>. <strong>No macros</strong>. <strong>IDE friendly</strong>. Endpoint descriptions are <strong>first-class Scala values</strong>, which can be reused, combined, and abstracted over.</p>
<p>The library currently supports the following backends:</p>
<ul>
<li>clients: Pekko HTTP, Akka HTTP, http4s, Play-WS, sttp, scalaj, XMLHttpRequest (Scala.js), and Fetch (Scala.js) ;</li>
<li>servers: Pekko HTTP, Akka HTTP, http4s, and Play ;</li>
<li>documentation: OpenAPI ;</li>
<li>JSON is supported via Circe, Play-Json, or ujson ;</li>
</ul>
<p>… but the library is designed to be <strong>extensible</strong>, anyone can:</p>
<ul>
<li>implement a new interpreter for the existing endpoint descriptions (e.g. generation of RAML documentation, finch client and server backend, etc.) ;</li>
<li>add new descriptions to the existing ones (e.g. to define an application-specific authentication strategy).</li>
</ul>
<h2><a href="#getting-started" name="getting-started" class="anchor"><span class="anchor-link"></span></a>Getting started</h2>
<ul>
<li>Have a look at the <a href="quick-start.html">quick start</a> guide to understand in a few minutes what the library does and how to setup a project ;</li>
<li>Check out the <a href="use-cases.html">use cases</a> to know the typical problems that endpoints4s addresses ;</li>
<li>Browse the <a href="api/endpoints4s/index.html" title="endpoints4s"><code>API documentation</code></a> or the <a href="https://github.com/endpoints4s/endpoints4s/tree/master/documentation/examples">samples</a>.</li>
</ul>
<h2><a href="#contributing" name="contributing" class="anchor"><span class="anchor-link"></span></a>Contributing</h2>
<p>See the <a href="https://github.com/endpoints4s/endpoints4s">Github repository</a>.</p>
<h2><a href="#sponsors" name="sponsors" class="anchor"><span class="anchor-link"></span></a>Sponsors</h2>
<p><a href="https://bestmile.com">Bestmile</a> supports engineering work on the project.</p>
</div>
<div>
<a href="https://github.com/endpoints4s/endpoints4s/tree/master/documentation/manual/src/main/paradox/index.md" title="Edit this page" class="md-source-file md-edit">
Edit this page
</a>
</div>
<div class="print-only">
<span class="md-source-file md-version">
1.12.1
</span>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="use-cases.html" title="Use Cases" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Use Cases
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
Powered by
<a href="https://github.com/lightbend/paradox">Paradox</a>
and
<a href="https://jonas.github.io/paradox-material-theme/">Paradox Material Theme</a>
</div>
<div class="md-footer-social">
<a href="https://github.com/endpoints4s/endpoints4s" class="md-footer-social__link fa fa-github"></a>
</div>
</div>
</div>
</footer>
</div>
<script src="assets/javascripts/application.583bbe55.js"></script>
<script src="assets/javascripts/paradox-material-theme.js"></script>
<script>app.initialize({version:"0.17",url:{base:"."}})</script>
<script type="text/javascript" src="lib/prettify/prettify.js"></script>
<script type="text/javascript" src="lib/prettify/lang-scala.js"></script>
<script type="text/javascript">
document.addEventListener("DOMContentLoaded", function(event) {
window.prettyPrint && prettyPrint();
});
</script>
</body>
</html>