Package io.micronaut.gradle.openapi

Interface OpenApiExtension

All Known Implementing Classes:
DefaultOpenApiExtension
public interface OpenApiExtension
Configures the OpenAPI code generator.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    client(File file, org.gradle.api.Action<? super OpenApiClientSpec> spec)
    Configures generation of a client, given a definition file.
    void
    client(String name, File definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)
    Configures generation of a server, given a definition file.
    void
    client(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)
    Configures generation of a server, given a definition file.
    org.gradle.api.provider.Property<String>
    getVersion()
    The version of the Micronaut OpenAPI generator.
    void
    server(File file, org.gradle.api.Action<? super OpenApiServerSpec> spec)
    Configures generation of a server, given a definition file.
    void
    server(String name, File definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)
    Configures generation of a server, given a definition file.
    void
    server(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)
    Configures generation of a server, given a definition file.

  • Method Details

    • getVersion

      org.gradle.api.provider.Property<String> getVersion()
      The version of the Micronaut OpenAPI generator.
      Returns:
      the version

    • server

      void server(File file, org.gradle.api.Action<? super OpenApiServerSpec> spec)
      Configures generation of a server, given a definition file.
      Parameters:
      file - the OpenAPI definition file
      spec - configuration for the server generation

    • client

      void client(File file, org.gradle.api.Action<? super OpenApiClientSpec> spec)
      Configures generation of a client, given a definition file.
      Parameters:
      file - the OpenAPI definition file
      spec - configuration for the client generation

    • server

      void server(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)
      Configures generation of a server, given a definition file.
      Parameters:
      name - an identifier used to uniquely refer to the generator, used to derive task names
      definition - the OpenAPI definition file provider
      spec - configuration for the server generation

    • client

      void client(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)
      Configures generation of a server, given a definition file.
      Parameters:
      name - an identifier used to uniquely refer to the generator, used to derive task names
      definition - the OpenAPI definition file provider
      spec - configuration for the server generation

    • server

      void server(String name, File definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)
      Configures generation of a server, given a definition file.
      Parameters:
      name - an identifier used to uniquely refer to the generator, used to derive task names
      definition - the OpenAPI definition file provider
      spec - configuration for the server generation

    • client

      void client(String name, File definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)
      Configures generation of a server, given a definition file.
      Parameters:
      name - an identifier used to uniquely refer to the generator, used to derive task names
      definition - the OpenAPI definition file provider
      spec - configuration for the server generation