Multiple API Documentation ("Views")

2.x version
Maintained

Multiple API Documentation ("Views")

With the views tag in the @ApiDoc annotation, it is possible to create different views of your API documentation. Without the tag, all methods are located in the default view, and can be found under the normal API documentation url.

You can specify one or more view names under which the method will be visible.

An example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
 * A resource
 *
 * @ApiDoc(
 *  resource=true,
 *  description="This is a description of your API method",
 *  views = { "default", "premium" }
 * )
 */
public function getAction()
{
}

/**
 * Another resource
 *
 * @ApiDoc(
 *  resource=true,
 *  description="This is a description of another API method",
 *  views = { "premium" }
 * )
 */
public function getAnotherAction()
{
}

In this case, only the first resource will be available under the default view, while both methods will be available under the premium view.

Accessing Specific API Views

The default view can be found at the normal location. Other views can be found at http://your.documentation/<view name>.

For instance, if your documentation is located at:

1
http://example.org/doc/api/v1/

then the premium view will be located at:

1
http://example.org/doc/api/v1/premium

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.