Serinus Banner

Serinus OpenAPI

A plugin to add OpenAPI Specification in your Serinus applications 🐤.

Installation

dart pub add serinus_openapi

Usage

Add the OpenApiModule to the imports of your main application module:

import 'package:serinus/serinus.dart';
import 'package:serinus_openapi/serinus_openapi.dart';

import 'app_controller.dart';
import 'app_provider.dart';

class AppModule extends Module {
  AppModule()
      : super(
          imports: [
            OpenApiModule.v3(
              InfoObject(
                title: 'Serinus OpenAPI Example',
                version: '1.0.0',
                description: 'An example of Serinus with OpenAPI integration',
              ),
            )
          ],
          controllers: [AppController()],
          providers: [AppProvider()],
        );
}

Libraries

serinus_openapi