Dart OpenAPI Code Generator

openapi_freezed_dio_builder generates client libraries for open api schema yaml files using Freezed and Dio.

This is a build_runner library meant to be included in the dev_dependencies of your project to allow generating of dart source files for client and server stubs for OpenAPI 3.0 schema files (Only yaml is supported right now).

See directory for an example usage.

You can also try out: the code generator right inside your browser: https://jonasbark.github.io/openapi_freezed_dio_builder/

Flutter Screenshot

Usage

  1. Update pubspec.yaml: 
     dependencies:
   freezed: any
   json_annotation: ^3.0.1
   openapi_base: any

 dev_dependencies:
   openapi_freezed_dio_builder: any
   json_serializable: ^3.3.0
   build_runner: ^1.10.0
  2. Create your schema file into your lib folder with the extension .openapi.yaml. You can also use a symbolic link.
  3. Optional: Add the base name to your schema 
    openapi: 3.0.0
info:
  x-dart-name: MyApiName
  4. Run the build_runner: 
    (flutter) pub run build_runner build --delete-conflicting-outputs
  5. Implement and client. (see below)

Supported OpenAPI types

Incomplete List, aside from standard model and API endpoints:

  • Multipart request
  • Freeform definitions
  • UUID format
  • Enums

Example schema

openapi: 3.0.0
info:
  version: 0.1.0
  title: Example API
  x-dart-name: TestApi

paths:
  /hello/{name}:
    parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
    get:
      summary: Say Hello World to {name}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelloResponse'
components:
  schemas:
    HelloResponse:
      properties:
        message:
          type: string
          description: 'The Hello World greeting ;-)'

Implement Client

Future<void> main() async {
   final client = Api(
      Dio(),
      Uri.parse('https://virtserver.swaggerhub.com/hpoul/Testapi/1.0.0'),
   );
   final blubb = await client.helloNameGet(name: 'Blubb');
   _logger.info('Response: ${blubb.data}');
}

dart run bin/example_client.dart

Try it out

Run in openapi_dart/packages/openapi_freezed_dio_builder/example

Special thanks

This is a fork of openapi_dart - thank you @hpoul for the great work!

Check out my other packages

Libraries

openapi_freezed_dio_builder