RestDocumentationService¶
-
public interface
RestDocumentationService
¶ This service allows retrieval of dynamically generated MDS REST documentation. This is an OSGi service interface, it is used by the mds-web module to serve the documentation through HTTP. The documentation returned is a JSON representation of the API in Swagger json format.
Methods¶
retrieveDocumentation¶
-
void
retrieveDocumentation
(Writer writer, String serverPrefix, Locale locale)¶ Writes REST API documentation the documentation to the writer provided.
Parameters: - writer – the output for the documentation.
- serverPrefix – the prefix of the server, for example /motech-platform-server, will be used in the swagger spec
- locale – the locale to be used while generating REST documentation