| Package | Description |
|---|---|
| com.linecorp.armeria.server.docs |
Documentation service.
|
| Modifier and Type | Method and Description |
|---|---|
static DocServiceBuilder |
DocService.builder()
Returns a new
DocServiceBuilder. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(Class<?> serviceType,
HttpHeaders... exampleHttpHeaders)
Adds the example
HttpHeaders for the service with the specified type. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(Class<?> serviceType,
Iterable<? extends HttpHeaders> exampleHttpHeaders)
Adds the example
HttpHeaders for the service with the specified type. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(Class<?> serviceType,
String methodName,
HttpHeaders... exampleHttpHeaders)
Adds the example
HttpHeaders for the method with the specified type and method name. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(Class<?> serviceType,
String methodName,
Iterable<? extends HttpHeaders> exampleHttpHeaders)
Adds the example
HttpHeaders for the method with the specified type and method name. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(HttpHeaders... exampleHttpHeaders)
Adds the example
HttpHeaders which are applicable to any services. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(Iterable<? extends HttpHeaders> exampleHttpHeaders)
Adds the example
HttpHeaders which are applicable to any services. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(String serviceName,
HttpHeaders... exampleHttpHeaders)
Adds the example
HttpHeaders for the service with the specified name. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(String serviceName,
Iterable<? extends HttpHeaders> exampleHttpHeaders)
Adds the example
HttpHeaders for the service with the specified name. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(String serviceName,
String methodName,
HttpHeaders... exampleHttpHeaders)
Adds the example
HttpHeaders for the method with the specified service and method name. |
DocServiceBuilder |
DocServiceBuilder.exampleHttpHeaders(String serviceName,
String methodName,
Iterable<? extends HttpHeaders> exampleHttpHeaders)
Adds the example
HttpHeaders for the method with the specified service and method name. |
DocServiceBuilder |
DocServiceBuilder.exampleRequest(Iterable<?> exampleRequests)
Adds the example requests which are applicable to the method denoted by the specified example requests.
|
DocServiceBuilder |
DocServiceBuilder.exampleRequest(Object... exampleRequests)
Adds the example requests which are applicable to the method denoted by the specified example requests.
|
DocServiceBuilder |
DocServiceBuilder.exampleRequestForMethod(Class<?> serviceType,
String methodName,
Iterable<?> exampleRequests)
Adds the example requests for the method with the specified service type and method name.
|
DocServiceBuilder |
DocServiceBuilder.exampleRequestForMethod(Class<?> serviceType,
String methodName,
Object... exampleRequests)
Adds the example requests for the method with the specified service type and method name.
|
DocServiceBuilder |
DocServiceBuilder.exampleRequestForMethod(String serviceName,
String methodName,
Iterable<?> exampleRequests)
Adds the example requests for the method with the specified service and method name.
|
DocServiceBuilder |
DocServiceBuilder.exampleRequestForMethod(String serviceName,
String methodName,
Object... exampleRequests)
Adds the example requests for the method with the specified service and method name.
|
DocServiceBuilder |
DocServiceBuilder.exclude(DocServiceFilter filter)
Adds the
DocServiceFilter that checks whether a method will be excluded while building
DocService. |
DocServiceBuilder |
DocServiceBuilder.include(DocServiceFilter filter)
Adds the
DocServiceFilter that checks whether a method will be included while building
DocService. |
DocServiceBuilder |
DocServiceBuilder.injectedScript(Iterable<String> scripts)
Adds Javascript scripts to inject into the
<head /> of the debug page HTML. |
DocServiceBuilder |
DocServiceBuilder.injectedScript(String... scripts)
Adds Javascript scripts to inject into the
<head /> of the debug page HTML. |
DocServiceBuilder |
DocServiceBuilder.injectedScriptSupplier(BiFunction<ServiceRequestContext,HttpRequest,String> supplier)
Adds a supplier for Javascript scripts to inject into the
<head /> of the debug page HTML. |
Copyright © 2020 LeanCloud. All rights reserved.