Type Members

1.  abstract class TapirGoldenOpenAPISuite extends FunSuite

   Base class for golden testing the generation of OpenAPI documentation for Tapir endpoints.

   Base class for golden testing the generation of OpenAPI documentation for Tapir endpoints.

   To use this class you just need to override the val endpoints: List[AnyEndpoint] definition with your list of endpoints to test.

   There are a bunch of things that can be overriden when generating the documentation:

   • tapirGoldenOpenAPIInfo: The info that will be used when generating the OpenAPI file.
   • tapirGoldenOpenAPIOptions: The options that will be used when generating the OpenAPI file.
   • tapirGoldenOpenAPIHeader: The value of this header that will be prepended to the generated YAML file.
   • tapirGoldenOpenAPIFileName: Name of the generated file with the OpenAPI documentation.
   • tapirGoldenOpenAPIPath: Folder where the OpenAPI file will be generated.

   Example:

   1. class EndpointsSuite extends munit.TapirGoldenOpenAPISuite {
      
        // Here you will add your list of endpoints
        override val endpoints: List[AnyEndpoint] = ???
      
      }