Flutter Swagger代码生成插件swagger_dart_code_generator_solve_generic的使用

📣 从Swagger/OpenAPI模式构建dart类型 #

SwaggerDartCodeGenerator是一个代码生成器，它查找*.swagger文件并基于模式生成.swagger.dart文件。代码生成基于Chopper和JsonAnnotation模型，并可以根据您的需求进行配置。

概述 #

通常情况下，每个.swagger文件将生成三种输出。
.dart由Swagger dart code generator生成，包含所有模型、请求、转换器等。
自v1.2.0起，.enums.dart由Swagger dart code generator生成，包含所有枚举和枚举映射。
.chopper.dart - 由chopper生成。
.g.dart - 由json_serializable生成。

安装 #

在pubspec.yaml文件中添加以下内容以支持代码生成：

dev_dependencies:
  chopper_generator: ^3.0.5
  json_annotation: ^3.0.1
  json_serializable: ^3.4.1
  swagger_dart_code_generator: any

运行时使用的包包括：

dependencies:
  chopper: ^3.0.3

然后运行以下命令来获取包：

pub packages get

或者

flutter packages get

现在，通过运行以下命令让SwaggerGenerator为您生成API文件：

pub run build_runner build

或者

flutter pub run build_runner build

配置 #

Swagger生成器提供了一些配置选项以生成代码。所有选项都应包含在项目的根目录下的build.yaml文件中：

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          # 自定义配置选项！

以下是配置选项表：

重要的是要记住，默认情况下，build会遵循Dart的包布局约定，这意味着只会考虑某些文件夹来解析输入文件。因此，如果您想引用lib/之外的文件夹中的文件，请确保已在sources中包含了该文件夹：

targets:
  $default:
    sources:
      - lib/**
      - swagger_examples/**
      - swaggers/**

模型生成的IncludeIfNull #

此选项用于为模型字段添加includeIfEmpty注解。如果未启用或为空，则includeIfNull注解将不会添加到字段中。详情请参阅官方文档。请参阅以下示例：

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          input_folder: 'lib/swaggers'
          output_folder: 'lib/generated_code/'
          include_if_null:
            enabled: true
            value: false

模型生成的默认值映射 #

如果您希望为特定类型的字段添加defaultValue:属性，可以使用默认值映射。请参阅以下示例：

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          input_folder: 'lib/swaggers'
          output_folder: 'lib/generated_code/'
          default_values_map:
            - type_name: int
              default_value: '36'
            - type_name: String
              default_value: 'default'
            - type_name: 'List<String>'
              default_value: '[]'

请求生成的响应覆盖值映射 #

如果您希望为具体的请求覆盖响应，可以使用response_override_value_map。例如：

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          input_folder: 'lib/swaggers'
          output_folder: 'lib/generated_code/'
          response_override_value_map:
            - url: '/store/inventory'
              method: get
              overridden_value: 'List<dynamic>'
            - url: '/news/latest'
              method: put
              overridden_value: 'MyPerfectType'

检查示例以详细了解如何使用它。

示例代码

example/lib/main.dart

import 'dart:async';
import 'package:example/generated_code/example_swagger.enums.swagger.dart';
import 'package:example/generated_code/example_swagger.swagger.dart';

Future main() async {
  final client = ExampleSwagger.create();

  final pet = Pet(
      name: 'Boris',
      tags: [],
      id: 11,
      photoUrls: [
        'https://i.pinimg.com/originals/de/71/bb/de71bb8a57ff473cc58ebc6af58c4858.jpg'
      ],
      category: Category(id: 1, name: 'Mops'),
      status: PetStatus.available);

  final postResult = await client.petPost(body: pet);

  if (postResult.statusCode != 200) {
    /// Some network error
  }

  final getResult = await client.petPetIdGet(petId: 11);

  if (getResult.statusCode != 200) {
    // Some network error
  }

  print(
      'Hello, my name is ${getResult.body!.name}, I am ${getResult.body!.category!.name}');
}