=htp move docs and create TOC structure
This commit is contained in:
parent
2d140eee30
commit
dc0c827ecf
12 changed files with 66 additions and 49 deletions
|
|
@ -1,21 +0,0 @@
|
||||||
.. _experimental:
|
|
||||||
|
|
||||||
####################
|
|
||||||
Experimental Modules
|
|
||||||
####################
|
|
||||||
|
|
||||||
The following modules of Akka are marked as experimental, which means
|
|
||||||
that they are in early access mode, which also means that they are not
|
|
||||||
covered by commercial support. The purpose of releasing them early, as
|
|
||||||
experimental, is to make them easily available and improve based on
|
|
||||||
feedback, or even discover that the module wasn't useful.
|
|
||||||
|
|
||||||
An experimental module doesn't have to obey the rule of staying binary
|
|
||||||
compatible between micro releases. Breaking API changes may be introduced
|
|
||||||
in minor releases without notice as we refine and simplify based on your
|
|
||||||
feedback. An experimental module may be dropped in minor releases without
|
|
||||||
prior deprecation.
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
|
|
@ -3,7 +3,8 @@
|
||||||
Java Documentation
|
Java Documentation
|
||||||
==================
|
==================
|
||||||
|
|
||||||
.. toctree::
|
.. note::
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
experimental/index
|
The documentation has not yet been ported to Java, you are welcome to read
|
||||||
|
the Scala version since all APIs are closely reflected between the two
|
||||||
|
language bindings.
|
||||||
|
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
Low-level HTTP API
|
|
||||||
==================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
model
|
|
||||||
server
|
|
||||||
client
|
|
||||||
https
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
HTTP Testkit
|
|
||||||
============
|
|
||||||
12
akka-docs-dev/rst/scala/http/index-client-server.rst
Normal file
12
akka-docs-dev/rst/scala/http/index-client-server.rst
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
.. _http-client-server-scala:
|
||||||
|
|
||||||
|
HTTP Client & Server
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
model
|
||||||
|
client
|
||||||
|
server
|
||||||
|
https
|
||||||
18
akka-docs-dev/rst/scala/http/index-routing.rst
Normal file
18
akka-docs-dev/rst/scala/http/index-routing.rst
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
.. _http-routing-index-scala:
|
||||||
|
|
||||||
|
HTTP Routing
|
||||||
|
============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
quick-start
|
||||||
|
routing
|
||||||
|
directives
|
||||||
|
rejections
|
||||||
|
exception-handling
|
||||||
|
path-matchers
|
||||||
|
marshalling
|
||||||
|
directives/alphabetically
|
||||||
|
directives/by-trait
|
||||||
|
|
||||||
8
akka-docs-dev/rst/scala/http/index-testkit.rst
Normal file
8
akka-docs-dev/rst/scala/http/index-testkit.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
.. _http-testkit-scala:
|
||||||
|
|
||||||
|
HTTP TestKit
|
||||||
|
============
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This part of the documentation has not yet been written, please stay tuned for updates.
|
||||||
|
|
@ -1,17 +1,28 @@
|
||||||
High-level HTTP API
|
.. _http-scala:
|
||||||
===================
|
|
||||||
|
Akka HTTP
|
||||||
|
=========
|
||||||
|
|
||||||
|
The purpose of the Akka HTTP layer is to expose Actors to the web via HTTP and
|
||||||
|
to enable them to consume HTTP services as a client. It is not an HTTP
|
||||||
|
framework, it is an Actor-based toolkit for interacting with web services and
|
||||||
|
clients. This toolkit is structured into several layers:
|
||||||
|
|
||||||
|
* ``akka-http-core``: A complete implementation of the HTTP standard, both as
|
||||||
|
client and server.
|
||||||
|
|
||||||
|
* ``akka-http``: A convenient and powerful routing DSL for expressing web
|
||||||
|
services.
|
||||||
|
|
||||||
|
* ``akka-http-testkit``: A test harness and set of utilities for verifying
|
||||||
|
your web service implementations.
|
||||||
|
|
||||||
|
Additionally there are several integration modules with bindings for different
|
||||||
|
serialization and deserialization schemes for HTTP entities.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
quick-start
|
index-client-server
|
||||||
routing
|
index-routing
|
||||||
directives
|
index-testkit
|
||||||
rejections
|
|
||||||
exception-handling
|
|
||||||
path-matchers
|
|
||||||
marshalling
|
|
||||||
directives/alphabetically
|
|
||||||
directives/by-trait
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue