com.h3c.sdn.adm.rsdoc

## Interface RSDocProvider

- All Known Implementing Classes:
    SelfRegisteringRSDocProvider

      public interface RSDocProvider

  Abstraction of a REST API documentation provider.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `InputStream` | `declaration(String resource)` Gets the REST API documentation for the specified service name.
    `String` | `name()` Gets the REST API provider name.
    `InputStream` | `resources()` Gets the root document for the REST API services offered by this provider.

- - ### Method Detail

    - #### name

          String name()

      Gets the REST API provider name.
      Returns:
        name of the provider

    - #### resources

          InputStream resources()

      Gets the root document for the REST API services offered by this provider. Contents are expected to conform to the Swagger Resource Listing specification.

      https://github.com/wordnik/swagger-core/wiki/Resource-Listing

      Returns:
        JSON root document stream

    - #### declaration

          InputStream declaration(String resource)

      Gets the REST API documentation for the specified service name. Contents are expected to conform to the Swagger API Declaration specification.

      https://github.com/wordnik/swagger-core/wiki/API-Declaration

      Parameters:
        `resource` - REST API resource name
      Returns:
        JSON document stream

Copyright © 2014. All Rights Reserved.