Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improvements to the Jetty documentation. 

Added introduction to the programming guide.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2020-09-03 10:47:38 +02:00
parent e3bfdd5219
commit cd0bf1cf5a
3 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
jetty-documentation/src/main/asciidoc/programming-guide/client/client.adoc
View File

@ -19,11 +19,12 @@
[[eg-client]]
== Client Libraries
The Eclipse Jetty Project provides also provides client-side libraries that allow you to embed a client in your applications.
The Eclipse Jetty Project provides client-side libraries that allow you to embed a client in your applications.
A typical example is a client application that needs to contact a third party service via HTTP (for example a REST service).
Another example is a proxy application that receives HTTP requests and forwards them as FCGI requests to a PHP application such as WordPress, or receives HTTP/1.1 requests and converts them to HTTP/2. Yet another example is a client application that needs to received events from a WebSocket server.
Another example is a proxy application that receives HTTP requests and forwards them as FCGI requests to a PHP application such as WordPress, or receives HTTP/1.1 requests and converts them to HTTP/2.
Yet another example is a client application that needs to receive events from a WebSocket server.
The client libraries are designed to be non-blocking and offer both synchronous and asynchronous APIs and come with a large number of configuration options.
The client libraries are designed to be non-blocking and offer both synchronous and asynchronous APIs and come with many configuration options.
These are the available client libraries:

1
jetty-documentation/src/main/asciidoc/programming-guide/index.adoc
View File

@ -57,6 +57,7 @@ endif::[]
:sectids!:
include::.asciidoctorconfig[]
include::introduction.adoc[]
include::client/client.adoc[]
include::server/server.adoc[]
include::maven/maven.adoc[]

29
jetty-documentation/src/main/asciidoc/programming-guide/introduction.adoc Normal file
View File

@ -0,0 +1,29 @@
//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
== Eclipse Jetty Programming Guide
The Eclipse Jetty Programming Guide targets developers that want to use the Eclipse Jetty libraries in their applications.
The Eclipse Jetty libraries provide the client-side and server-side APIs to work with various web protocols such as HTTP/1.1, HTTP/2, WebSocket and FastCGI.
You may use the xref:eg-client[Eclipse Jetty client-side library] in your application to make calls to third party REST services, or to other REST microservices in your system.
Likewise, you may use the xref:eg-server[Eclipse Jetty server-side library] to quickly create an HTTP or REST service without having to create a web application archive file (a `*.war` file) and deploy it to server that you have to download and install.
This guide will walk you through the design of the Eclipse Jetty and how to use its classes to write your applications.