package-info.java

/*
   Copyright (c) 2012 LinkedIn Corp.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

/**
 * <p>Documentation generator for Rest.li server.</p>
 *
 * <p>When passing an implementation of {@link com.linkedin.restli.server.RestLiDocumentationRequestHandler} to
 * {@link com.linkedin.restli.server.RestLiServer} through {@link com.linkedin.restli.server.RestLiConfig},
 * the server will respond to special URLs with documentation content such as HTML page or JSON object.</p>
 *
 * <p>The default implementation {@link com.linkedin.restli.docgen.DefaultDocumentationRequestHandler} renders
 * both HTML and JSON documentation.</p>
 *
 * <p>It also provides an OPTIONS http method alias to the JSON documentation content.</p>
 */
package com.linkedin.restli.docgen;