Interface SpecRestApiProps

All Superinterfaces:, RestApiBaseProps
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-23T02:06:27.582Z") @Stability(Stable) public interface SpecRestApiProps extends, RestApiBaseProps
Props to instantiate a new SpecRestApi.


 Integration integration;
 SpecRestApi api = SpecRestApi.Builder.create(this, "books-api")
 Resource booksResource = api.root.addResource("books");
 booksResource.addMethod("GET", integration);
  • Method Details

    • getApiDefinition

      @Stability(Stable) @NotNull ApiDefinition getApiDefinition()
      An OpenAPI definition compatible with API Gateway.

      See Also:
    • getMinCompressionSize

      @Stability(Stable) @Nullable default Size getMinCompressionSize()
      A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.

      When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

      Default: - Compression is disabled.

    • builder

      @Stability(Stable) static SpecRestApiProps.Builder builder()
      a SpecRestApiProps.Builder of SpecRestApiProps