GitHub-Mirror/Tapeti
1
0
Fork 0
mirror of synced 2024-11-21 08:53:50 +00:00
Code Issues Projects Releases Wiki Activity

Reorganized the documentation so that the introduction is the landing page.

Browse Source 
Learned that the Tapeti is now classified as endangered. No implications for this library I hope!
This commit is contained in:
Mark van Renswoude 2019-08-20 12:17:48 +02:00
parent bef3961f7f
commit 502df0ffee
2 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/index.rst
View File

@ -1,11 +1,38 @@
Tapeti documentation
====================
Introduction
============
| 'Small to medium-sized and classified as "Least Concern" by the IUCN.'
| `Wikipedia <https://en.wikipedia.org/wiki/Tapeti>`_ [*]_
.. [*] Before it was marked as "Endangered" in 2019 and the pun no longer works.
Tapeti is a wrapper for the RabbitMQ .NET Client designed for long-running microservices. It's main goal is to minimize the amount of messaging code required, and instead focus on the higher-level flow.
Tapeti is built using .NET Standard 2.0 and mostly tested using .NET 4.7.
Key features
------------
* Consumers are declared using MVC-style controllers and are registered automatically based on annotations
* Publishing requires only the message class, no transport details such as exchange and routing key
* :doc:`flow` (stateful request - response handling with support for parallel requests)
* No inheritance required
* Graceful recovery in case of connection issues, and in contrast to most libraries not designed for services, during startup as well
* Extensible using middleware
What it is not
--------------
Tapeti is not a general purpose RabbitMQ client. Although some behaviour can be overridden by implementing various interfaces, it enforces it's style of messaging and assumes everyone on the bus speaks the same language.
There is no support for TLS connections, nor are there any plans to support it. The author is of the opinion the message bus should be considered an internal, highly available, service and recommends self-hosted REST API's behind an SSL proxy for communicating over public interfaces.
.. toctree::
:maxdepth: 2
:caption: Contents:
:hidden:
introduction
index
gettingstarted
indepth
dataannotations

26
docs/introduction.rst
View File

@ -1,26 +0,0 @@
Introduction
============
| 'Small to medium-sized and classified as "Least Concern" by the IUCN.'
| `Wikipedia <https://en.wikipedia.org/wiki/Tapeti>`_
Tapeti is a wrapper for the RabbitMQ .NET Client designed for long-running microservices. It's main goal is to minimize the amount of messaging code required, and instead focus on the higher-level flow.
Tapeti is built using .NET Standard 2.0 and mostly tested using .NET 4.7.
Key features
------------
* Consumers are declared using MVC-style controllers and are registered automatically based on annotations
* Publishing requires only the message class, no transport details such as exchange and routing key
* :doc:`flow` (stateful request - response handling with support for parallel requests)
* No inheritance required
* Graceful recovery in case of connection issues, and in contrast to most libraries not designed for services, during startup as well
* Extensible using middleware
What it is not
--------------
Tapeti is not a general purpose RabbitMQ client. Although some behaviour can be overridden by implementing various interfaces, it enforces it's style of messaging and assumes everyone on the bus speaks the same language.
There is no support for TLS connections, nor are there any plans to support it. The author is of the opinion the message bus should be considered an internal, highly available, service and recommends self-hosted REST API's behind an SSL proxy for communicating over public interfaces.