Constructor Detail

• RestApi

  RestApi(List<RestApi> dependsOn)

Method Detail

• getBasePath

   final String getBasePath()

• setBasePath

   final Unit setBasePath(String basePath)

• getOpenapiVersion

   final String getOpenapiVersion()

• setOpenapiVersion

   final Unit setOpenapiVersion(String openapiVersion)

• getInfo

   final OasInfo getInfo()

• getServers

   final List<OasServer> getServers()

• getTags

   final List<OasTag> getTags()

• getOperations

   final List<Operation> getOperations()

• getParameters

   final List<Parameter> getParameters()

• getResponses

   final List<HttpResponseSchema> getResponses()

• getSchemas

   final List<DataSchema> getSchemas()

• getSecuritySchemas

   final List<SecuritySchema> getSecuritySchemas()

• getName

   String getName()

• setName

   Unit setName(String name)

• getLocation

   String getLocation()

• setLocation

   Unit setLocation(String location)

• getGroupedOperations

   final Map<String, List<Operation>> getGroupedOperations()

• getDefaultErrorResponse

   final DataType getDefaultErrorResponse()

• getDependsOn

   List<RestApi> getDependsOn()

• toString

   String toString()

• getOperation

   final Operation getOperation(String code)

• forEachOperation

   final RestApi forEachOperation(Function1<Operation, Unit> consumer)

• removeOperations

   final RestApi removeOperations(Predicate<Operation> filter)

• addSchema

   final RestApi addSchema(DataSchema schema)

• forEachSchema

   final RestApi forEachSchema(Function1<DataSchema, Unit> consumer)

• updateSchema

   final RestApi updateSchema(String code, Function1<DataSchema, Unit> consumer)

• getSchema

   final DataSchema getSchema(String code)

  Gets a DataSchema object representing the object's schema in the OpenAPI specification.

  You can get the schema of an object or the schema for an object's property. To get the schema for an object's property, the code parameter should be a combination of the object code and the property code: <OBJECT_SCHEMA_NAME>.<PROPERTY_NAME>.

• addParameter

   final RestApi addParameter(Parameter parameter)

• getParameter

   final Parameter getParameter(String codeOrName)

• getResponse

   final HttpResponseSchema getResponse(String code)

• findSchema

   final DataSchema findSchema(String code)

• of

   final static RestApi of(String content, RestApi dependencies)

• of

  @JvmOverloads() final static MultipartRestApi of(File file, Charset charset)

• of

  @JvmOverloads() final static MultipartRestApi of(File file)