REPOSE Documentation

Up-to-date information on current REPOSE features and plans is on the REPOSE wiki. In the wiki, visit Release Notes to learn about new features, bug fixes, and known issues; check the list of REPOSE components to see whether we might have a solution ready for your problem.

We are developing three forms of documentation: expanded explanations and annotated examples assembled into books; quick notes in our wiki; step-by-step tutorials. We are especially interested in expanding the collection of tutorials; if you'd like to help, contact our writer.

We create deployment guides and other documentation as features are added and released. Some documents apply to REPOSE generally; others relate to specific REPOSE components. Click on a book title below to open it as HTML; to open the same book as PDF, click the Acrobat icon at the top of any HTML page.

About REPOSE

TOPIC		BOOK		WIKI PAGE(s)		TUTORIAL(s)
		expanded explanations and annotated examples		quick notes		step-by-step
Deployment						Quick Installation (快速安装手册) and Setting up Repose: The REstful Proxy Service Engine
Getting Started		REPOSE Getting Started
Glossary		REPOSE Glossary
Release Notes				Release Notes

About Specific REPOSE Components

COMPONENT(s)		BOOK		WIKI PAGE(s)		TUTORIAL(s)
		expanded explanations and annotated examples		quick notes		step-by-step
Authentication and Authorization		REPOSE Authentication and Authorization Components Deployment Handbook		Client Authentication Filter and Client Authorization Filter
HTTP Logging		REPOSE HTTP Logging Component Deployment Handbook		HTTP Logging Filter
Rate Limiting		REPOSE Rate Limiting Component Deployment Handbook		Rate Limiting Filter		Rate Limiting with Repose
Translation		REPOSE Translation Component Deployment Handbook		Translation
Validation		REPOSE API Validation Component Deployment Handbook		API (WADL/XSD) Validation Filter
Versioning		REPOSE Versioning Component Deployment Handbook		Versioning Filter

Many other components are documented primarily in the wiki; check the list of REPOSE components if you are looking for documentation you do not see listed above.

Documentation source is included with the REPOSE source code on GitHub. To generate your own copy of the HTML and PDF documents, follow the doc build instructions in our wiki or contact our writer if you'd like help.