Book Image

Mastering ServiceStack

By : Andreas Niedermair
Book Image

Mastering ServiceStack

By: Andreas Niedermair

Overview of this book

Table of Contents (13 chapters)

Metadata page

Adding documentation to your API is a key aspect while creating an understandable and accepted interface. You can roll an automatically generated documentation with your service that ServiceStack populates through annotations on your DTOs. This documentation is generated by the metadata feature (enabled by default) and can be reached by browsing /metadata, which makes the following information available:

  1. A complete list of XML Schema Definition (XSD) types for all services.

  2. A list of all operations excluding the ones that have been hidden by using [ServiceStack.RestrictAttribute(VisibilityTo = ServiceStack.RequestAttributes.None)].

  3. Links to all available content formats excluding the ones that have been ignored by your app host's Config.IgnoreFormatsInMetadata collection or annotated with [ServiceStack.RestricitAttribute(VisibilityTo = ServiceStack.RequestAttributes.Any & ~ServiceStack.RequestAttributes.Xml)].

  4. Links to SOAP 1.1 and 1.2 WSDLs.

  5. Links to additional debug information...